|
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
namespace CommonGenius.Collections
{
/// <summary>
/// Represents a generic collection of key/value pairs that are ordered independently of the key and value.
/// </summary>
/// <typeparam name="TKey">The type of the keys in the dictionary</typeparam>
/// <typeparam name="TValue">The type of the values in the dictionary</typeparam>
public interface IOrderedDictionary<TKey, TValue> : IOrderedDictionary, IDictionary<TKey, TValue>
{
/// <summary>
/// Adds an entry with the specified key and value into the <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> collection with the lowest available index.
/// </summary>
/// <param name="key">The key of the entry to add.</param>
/// <param name="value">The value of the entry to add.</param>
/// <returns>The index of the newly added entry</returns>
/// <remarks>
/// <para>You can also use the <see cref="P:System.Collections.Generic.IDictionary{TKey,TValue}.Item(TKey)"/> property to add new elements by setting the value of a key that does not exist in the <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> collection; however, if the specified key already exists in the <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see>, setting the <see cref="P:Item(TKey)"/> property overwrites the old value. In contrast, the <see cref="M:Add"/> method does not modify existing elements.</para></remarks>
/// <exception cref="ArgumentException">An element with the same key already exists in the <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see></exception>
/// <exception cref="NotSupportedException">The <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> is read-only.<br/>
/// -or-<br/>
/// The <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> has a fized size.</exception>
new int Add(TKey key, TValue value);
/// <summary>
/// Inserts a new entry into the <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> collection with the specified key and value at the specified index.
/// </summary>
/// <param name="index">The zero-based index at which the element should be inserted.</param>
/// <param name="key">The key of the entry to add.</param>
/// <param name="value">The value of the entry to add. The value can be <null/> if the type of the values in the dictionary is a reference type.</param>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
/// -or-<br/>
/// <paramref name="index"/> is greater than <see cref="System.Collections.ICollection.Count"/>.</exception>
/// <exception cref="ArgumentException">An element with the same key already exists in the <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see>.</exception>
/// <exception cref="NotSupportedException">The <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> is read-only.<br/>
/// -or-<br/>
/// The <see cref="IOrderedDictionary{TKey,TValue}">IOrderedDictionary<TKey,TValue></see> has a fized size.</exception>
void Insert(int index, TKey key, TValue value);
/// <summary>
/// Gets or sets the value at the specified index.
/// </summary>
/// <param name="index">The zero-based index of the value to get or set.</param>
/// <value>The value of the item at the specified index.</value>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="index"/> is less than 0.<br/>
/// -or-<br/>
/// <paramref name="index"/> is equal to or greater than <see cref="System.Collections.ICollection.Count"/>.</exception>
new TValue this[int index]
{
get;
set;
}
}
}
|
By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please
let us know and we'll add colourisation support for it.
David Nelson has been programming in various languages for 17 years, and has been programming in .NET (C# and VB.NET) since 2003.
He is a MCTS in .NET 2.0 Web Applications, and is a moderator on the MSDN Forums (http://forums.microsoft.com/msdn).