using System;
using System.Collections;
using System.Collections.Generic;
namespace newtelligence.DasBlog.Runtime{
/// <summary>
/// Relatively simple implementation of a threadsafe list. Uses a List{T} for storage and uses
/// it's methods for the heavy lifting.
/// </summary>
/// <typeparam name="T"></typeparam>
public class SynchronisedList<T> : ICollection<T>, IList<T>, ICollection, IList
{
// container for the items
private List<T> items;
// locking object to synchronise access
private object syncRoot = new object();
/// <summary>
/// Initializes a new instance of the <see cref="SynchronisedList<T>"/> class.
/// </summary>
public SynchronisedList()
{
this.items = new List<T>();
}
/// <summary>
/// Initializes a new instance of the <see cref="SynchronisedList<T>"/> class.
/// </summary>
/// <param name="capacity">The capacity.</param>
public SynchronisedList(int capacity)
{
this.items = new List<T>(capacity);
}
/// <summary>
/// Initializes a new instance of the <see cref="SynchronisedList<T>"/> class.
/// </summary>
/// <param name="list">The list.</param>
public SynchronisedList(IEnumerable<T> list)
{
this.items = new List<T>(list);
}
/// <summary>
/// Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>.
/// </summary>
/// <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
/// <returns>
/// The index of <paramref name="item"/> if found in the list; otherwise, -1.
/// </returns>
public int IndexOf(T item)
{
lock (syncRoot)
{
return this.items.IndexOf(item);
}
}
/// <summary>
/// Inserts an item to the <see cref="T:System.Collections.Generic.IList`1"/> at the specified index.
/// </summary>
/// <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
/// <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
/// <exception cref="T:System.ArgumentOutOfRangeException">
/// <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception>
public void Insert(int index, T item)
{
lock (syncRoot)
{
this.items.Insert(index, item);
}
}
/// <summary>
/// Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index.
/// </summary>
/// <param name="index">The zero-based index of the item to remove.</param>
/// <exception cref="T:System.ArgumentOutOfRangeException">
/// <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception>
public void RemoveAt(int index)
{
lock (syncRoot)
{
this.RemoveAt(index);
}
}
/// <summary>
/// Gets or sets the element at the specified index.
/// </summary>
/// <value></value>
public T this[int index]
{
get
{
lock (syncRoot)
{
return this.items[index];
}
}
set
{
lock (syncRoot)
{
this.items[index] = value;
}
}
}
/// <summary>
/// Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>.
/// </summary>
/// <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception>
public void Add(T item)
{
lock (syncRoot)
{
this.items.Add(item);
}
}
/// <summary>
/// Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
/// </summary>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. </exception>
public void Clear()
{
lock (syncRoot)
{
this.items.Clear();
}
}
/// <summary>
/// Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value.
/// </summary>
/// <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
/// <returns>
/// true if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false.
/// </returns>
public bool Contains(T item)
{
lock (syncRoot)
{
return this.items.Contains(item);
}
}
/// <summary>
/// Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
/// </summary>
/// <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
/// <param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
/// <exception cref="T:System.ArgumentNullException">
/// <paramref name="array"/> is null.</exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">
/// <paramref name="arrayIndex"/> is less than 0.</exception>
/// <exception cref="T:System.ArgumentException">
/// <paramref name="array"/> is multidimensional.-or-<paramref name="arrayIndex"/> is equal to or greater than the length of <paramref name="array"/>.-or-The number of elements in the source <see cref="T:System.Collections.Generic.ICollection`1"/> is greater than the available space from <paramref name="arrayIndex"/> to the end of the destination <paramref name="array"/>.-or-Type <paramref name="T"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.</exception>
public void CopyTo(T[] array, int arrayIndex)
{
lock (syncRoot)
{
this.items.CopyTo(array, arrayIndex);
}
}
/// <summary>
/// Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
/// </summary>
/// <value></value>
/// <returns>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</returns>
public int Count
{
get
{
lock (syncRoot)
{
return this.items.Count;
}
}
}
/// <summary>
/// Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
/// </summary>
/// <value></value>
/// <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, false.</returns>
bool ICollection<T>.IsReadOnly
{
get { return false; }
}
/// <summary>
/// Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
/// </summary>
/// <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
/// <returns>
/// true if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. This method also returns false if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>.
/// </returns>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception>
public bool Remove(T item)
{
lock (syncRoot)
{
return this.items.Remove(item);
}
}
/// <summary>
/// Returns an enumerator that iterates through the collection.
/// </summary>
/// <returns>
/// A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
/// </returns>
public IEnumerator<T> GetEnumerator()
{
lock (syncRoot)
{
return this.items.GetEnumerator();
}
}
/// <summary>
/// Returns an enumerator that iterates through a collection.
/// </summary>
/// <returns>
/// An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
/// </returns>
IEnumerator IEnumerable.GetEnumerator()
{
lock (syncRoot)
{
return this.items.GetEnumerator();
}
}
/// <summary>
/// Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
/// </summary>
/// <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.ICollection"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
/// <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
/// <exception cref="T:System.ArgumentNullException">
/// <paramref name="array"/> is null. </exception>
/// <exception cref="T:System.ArgumentOutOfRangeException">
/// <paramref name="index"/> is less than zero. </exception>
/// <exception cref="T:System.ArgumentException">
/// <paramref name="array"/> is multidimensional.-or- <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.-or- The number of elements in the source <see cref="T:System.Collections.ICollection"/> is greater than the available space from <paramref name="index"/> to the end of the destination <paramref name="array"/>. </exception>
/// <exception cref="T:System.ArgumentException">The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>. </exception>
void ICollection.CopyTo(Array array, int index)
{
lock (syncRoot)
{
((ICollection)this.items).CopyTo(array, index);
}
}
/// <summary>
/// Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread safe).
/// </summary>
/// <value></value>
/// <returns>true if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread safe); otherwise, false.</returns>
bool ICollection.IsSynchronized
{
get { return true; }
}
/// <summary>
/// Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
/// </summary>
/// <value></value>
/// <returns>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.</returns>
object ICollection.SyncRoot
{
get { return this.syncRoot; }
}
/// <summary>
/// Adds an item to the <see cref="T:System.Collections.IList"/>.
/// </summary>
/// <param name="value">The <see cref="T:System.Object"/> to add to the <see cref="T:System.Collections.IList"/>.</param>
/// <returns>
/// The position into which the new element was inserted.
/// </returns>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.IList"/> is read-only.-or- The <see cref="T:System.Collections.IList"/> has a fixed size. </exception>
int IList.Add(object value)
{
lock (syncRoot)
{
return ((IList)this.items).Add(value);
}
}
/// <summary>
/// Determines whether the <see cref="T:System.Collections.IList"/> contains a specific value.
/// </summary>
/// <param name="value">The <see cref="T:System.Object"/> to locate in the <see cref="T:System.Collections.IList"/>.</param>
/// <returns>
/// true if the <see cref="T:System.Object"/> is found in the <see cref="T:System.Collections.IList"/>; otherwise, false.
/// </returns>
bool IList.Contains(object value)
{
lock (syncRoot)
{
return ((IList)this.items).Contains(value);
}
}
/// <summary>
/// Determines the index of a specific item in the <see cref="T:System.Collections.IList"/>.
/// </summary>
/// <param name="value">The <see cref="T:System.Object"/> to locate in the <see cref="T:System.Collections.IList"/>.</param>
/// <returns>
/// The index of <paramref name="value"/> if found in the list; otherwise, -1.
/// </returns>
int IList.IndexOf(object value)
{
lock (syncRoot)
{
return ((IList)this.items).IndexOf(value);
}
}
/// <summary>
/// Inserts an item to the <see cref="T:System.Collections.IList"/> at the specified index.
/// </summary>
/// <param name="index"></param>
/// <param name="value">The <see cref="T:System.Object"/> to insert into the <see cref="T:System.Collections.IList"/>.</param>
/// <exception cref="T:System.ArgumentOutOfRangeException">
/// <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.IList"/>. </exception>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.IList"/> is read-only.-or- The <see cref="T:System.Collections.IList"/> has a fixed size. </exception>
/// <exception cref="T:System.NullReferenceException">
/// <paramref name="value"/> is null reference in the <see cref="T:System.Collections.IList"/>.</exception>
void IList.Insert(int index, object value)
{
lock (syncRoot)
{
((IList)this.items).Insert(index, value);
}
}
/// <summary>
/// Gets a value indicating whether the <see cref="T:System.Collections.IList"/> has a fixed size.
/// </summary>
/// <value></value>
/// <returns>true if the <see cref="T:System.Collections.IList"/> has a fixed size; otherwise, false.</returns>
bool IList.IsFixedSize
{
get { return false; }
}
/// <summary>
/// Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
/// </summary>
/// <value></value>
/// <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, false.</returns>
bool IList.IsReadOnly
{
get { return false; }
}
/// <summary>
/// Removes the first occurrence of a specific object from the <see cref="T:System.Collections.IList"/>.
/// </summary>
/// <param name="value">The <see cref="T:System.Object"/> to remove from the <see cref="T:System.Collections.IList"/>.</param>
/// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.IList"/> is read-only.-or- The <see cref="T:System.Collections.IList"/> has a fixed size. </exception>
void IList.Remove(object value)
{
lock (syncRoot)
{
((IList)this.items).Remove(value);
}
}
/// <summary>
/// Gets or sets the <see cref="System.Object"/> at the specified index.
/// </summary>
/// <value></value>
object IList.this[int index]
{
get
{
lock (syncRoot)
{
return ((IList)this.items)[index];
}
}
set
{
lock (syncRoot)
{
((IList)this.items)[index] = value;
}
}
}
protected List<T> Items
{
get
{
return this.items;
}
}
public T Find(Predicate<T> match)
{
lock (syncRoot)
{
return this.items.Find(match);
}
}
public int FindIndex(Predicate<T> match)
{
lock (syncRoot)
{
return this.items.FindIndex(match);
}
}
public T[] ToArray()
{
lock (syncRoot)
{
return this.items.ToArray();
}
}
/// <summary>
///
/// </summary>
/// <remarks>Since you're probably using this in a multithreaded environment; remember that when other threads
/// could modify the collection after you sorted it, making it unsorted.</remarks>
public void Sort()
{
lock (syncRoot)
{
this.items.Sort();
}
}
/// <summary>
///
/// </summary>
/// <remarks>Since you're probably using this in a multithreaded environment; remember that when other threads
/// could modify the collection after you sorted it, making it unsorted.</remarks>
public void Sort(IComparer<T> comparer)
{
lock (syncRoot)
{
this.items.Sort(comparer);
}
}
/// <summary>
///
/// </summary>
/// <remarks>Since you're probably using this in a multithreaded environment; remember that when other threads
/// could modify the collection after you sorted it, making it unsorted.</remarks>
public void Sort(Comparison<T> comparison)
{
lock (syncRoot)
{
this.items.Sort(comparison);
}
}
/// <summary>
///
/// </summary>
/// <remarks>Since you're probably using this in a multithreaded environment; remember that when other threads
/// could modify the collection after you sorted it, making it unsorted.</remarks>
public void Sort(int index, int count, IComparer<T> comparer)
{
lock (syncRoot)
{
this.items.Sort(index, count, comparer);
}
}
public void RemoveRange(int index, int count)
{
lock (syncRoot)
{
this.items.RemoveRange(index, count);
}
}
}
}
|