/branches/2.x/Dorian/Gorgon/Gorgon.Common/Collections/Specialized/GorgonTrackedObjectCollection.cs

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;



namespace GorgonLibrary.Collections.Specialized

{

	/// <summary>

	/// A collection of custom objects that are managed by the another interface.

	/// </summary>

	/// <remarks>This collection is intended for use by objects that manage the lifetimes of any child objects created from it.</remarks>

	public class GorgonTrackedObjectCollection

		: IList<IDisposable>

	{

		#region Variables.

		private IList<IDisposable> _objects = null;			// List of tracked objects.

		#endregion



		#region Methods.

		/// <summary>

		/// Function to clean up all objects in the collection.

		/// </summary>

		public void ReleaseAll()

		{

			var items = _objects.ToArray();



			foreach (var item in items)

				item.Dispose();



			_objects.Clear();

		}

		#endregion



		#region Constructor.

		/// <summary>

		/// Initializes a new instance of the <see cref="GorgonTrackedObjectCollection"/> class.

		/// </summary>

		public GorgonTrackedObjectCollection()

		{

			_objects = new List<IDisposable>();

		}

		#endregion



		#region IList<IDisposable> Members

		#region Properties.

		/// <summary>

		/// Gets or sets the element at the specified index.

		/// </summary>

		/// <returns>

		/// The element at the specified index.

		///   </returns>

		///   

		/// <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 property is set and the <see cref="T:System.Collections.Generic.IList`1"/> is read-only.

		///   </exception>

		public IDisposable this[int index]

		{

			get

			{

				return _objects[index];

			}

			set

			{

				throw new NotSupportedException();

			}

		}

		#endregion



		#region Methods.

		/// <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(IDisposable item)

		{

			return _objects.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>

		void IList<IDisposable>.Insert(int index, IDisposable item)

		{

			throw new NotSupportedException();

		}



		/// <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>

		void IList<IDisposable>.RemoveAt(int index)

		{

			throw new NotSupportedException();

		}

		#endregion

		#endregion



		#region ICollection<IDisposable> Members

		#region Properties.

		/// <summary>

		/// Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.

		/// </summary>

		/// <returns>

		/// The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.

		///   </returns>

		public int Count

		{

			get 

			{

				return _objects.Count;

			}

		}



		/// <summary>

		/// Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.

		/// </summary>

		/// <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, false.

		///   </returns>

		public bool IsReadOnly

		{

			get

			{

				return false;

			}

		}

		#endregion



		#region Methods.

		/// <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(IDisposable item)

		{

			if (!_objects.Contains(item))

				_objects.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>

		void ICollection<IDisposable>.Clear()

		{

			throw new NotSupportedException();

		}



		/// <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(IDisposable item)

		{

			return _objects.Contains(item);

		}



		/// <summary>

		/// Copies to.

		/// </summary>

		/// <param name="array">The array.</param>

		/// <param name="arrayIndex">Index of the array.</param>

		void ICollection<IDisposable>.CopyTo(IDisposable[] array, int arrayIndex)

		{

			throw new NotSupportedException();

		}



		/// <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(IDisposable item)

		{

			if (!_objects.Contains(item))

				return false;



			return _objects.Remove(item);

		}

		#endregion

		#endregion



		#region IEnumerable<IDisposable> Members

		/// <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<IDisposable> GetEnumerator()

		{

			foreach (IDisposable item in _objects)

				yield return item;

		}

		#endregion



		#region IEnumerable Members

		/// <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>

		System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()

		{

			return GetEnumerator();

		}

		#endregion

	}

}