SortedDictionary Class

Oracle® Fusion Middleware .NET API Reference for Oracle Coherence
14c (14.1.1.0)
F23534-02

SortedList-based IDictionary implementation that allows null keys.

Inheritance Hierarchy

SystemObject
System.CollectionsSortedList
Tangosol.Util.CollectionsSortedDictionary

Namespace: Tangosol.Util.Collections
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)

Syntax

Copy

[SerializableAttribute]
public class SortedDictionary : SortedList, 
	IEnumerable, ISerializable

The SortedDictionary type exposes the following members.

Constructors

	Name	Description
	SortedDictionary	Initializes a new instance of the SortedDictionary class that is empty, has the default initial capacity, and is sorted according to the IComparable interface implemented by each key added to the SortedDictionary object.
	SortedDictionary(IComparer)	Initializes a new instance of the SortedDictionary class that is empty, has the default initial capacity, and is sorted according to the specified IComparer interface.
	SortedDictionary(IDictionary)	Initializes a new instance of the SortedDictionary class that contains elements copied from the specified dictionary, has the same initial capacity as the number of elements copied, and is sorted according to the IComparable interface implemented by each key.
	SortedDictionary(Int32)	Initializes a new instance of the SortedDictionary class that is empty, has the specified initial capacity, and is sorted according to the IComparable interface implemented by each key added to the SortedDictionary object.
	SortedDictionary(IComparer, Int32)	Initializes a new instance of the SortedDictionary class that is empty, has the specified initial capacity, and is sorted according to the specified IComparer interface.
	SortedDictionary(IDictionary, IComparer)	Initializes a new instance of the SortedDictionary class that contains elements copied from the specified dictionary, has the same initial capacity as the number of elements copied, and is sorted according to the specified IComparer interface.
	SortedDictionary(SerializationInfo, StreamingContext)	Initializes a new instance of the SortedDictionary class that is serializable using the specified SerializationInfo and StreamingContext objects.

Top

Properties

	Name	Description
	Capacity	Gets or sets the capacity of a SortedList object. (Inherited from SortedList.)
	Comparer	Return the IComparer associated with this SortedDictionary.
	Count	Gets the number of elements contained in the ICollection. (Overrides SortedListCount.)
	IsFixedSize	Gets a value indicating whether a SortedList object has a fixed size. (Inherited from SortedList.)
	IsNullValueSet	Returns true is the value for the null key is set, false otherwise.
	IsReadOnly	Gets a value indicating whether a SortedList object is read-only. (Inherited from SortedList.)
	IsSynchronized	Gets a value indicating whether access to a SortedList object is synchronized (thread safe). (Inherited from SortedList.)
	Item	Gets or sets the element with the specified key. (Overrides SortedListItemObject.)
	Keys	Gets an ICollection object containing the keys of this dictionary. (Overrides SortedListKeys.)
	SyncRoot	Gets an object that can be used to synchronize access to a SortedList object. (Inherited from SortedList.)
	Values	Gets an ICollection object containing the values in this dictionary. (Overrides SortedListValues.)

Top

Methods

	Name	Description
	Add	Adds an element with the provided key and value to the IDictionary object. (Overrides SortedListAdd(Object, Object).)
	AssertIsVariableSize	Throw an exception if this dictionary is fixed size.
	AssertIsWriteable	Throw an exception if this dictionary is read-only.
	Clear	Removes all elements from the IDictionary object. (Overrides SortedListClear.)
	Clone	Creates a new object that is a copy of the current instance. (Overrides SortedListClone.)
	Contains	Determines whether this dictionary contains an entry with the specified key. (Overrides SortedListContains(Object).)
	ContainsKey	Determines whether the SortedDictionary contains a specific key. (Overrides SortedListContainsKey(Object).)
	ContainsValue	Determines whether the SortedDictionary contains a specific value. (Overrides SortedListContainsValue(Object).)
	CopyTo	Copies the elements of the collection to an array, starting at a particular array index. (Overrides SortedListCopyTo(Array, Int32).)
	Equals(IDictionary)	Compares this dictionary with another dictionary for equality.
	Equals(Object)	Determines whether the specified object is equal to this object. (Overrides ObjectEquals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetByIndex	Gets the value at the specified index of a SortedList object. (Inherited from SortedList.)
	GetEnumerator	Returns an IDictionaryEnumerator object for this dictionary. (Overrides SortedListGetEnumerator.)
	GetHashCode	Returns a hash code for this object. (Overrides ObjectGetHashCode.)
	GetKey	Gets the key at the specified index of a SortedList object. (Inherited from SortedList.)
	GetKeyList	Gets the keys in a SortedList object. (Inherited from SortedList.)
	GetObjectData	Overrides serialization method to add support for null value serialization.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValueList	Gets the values in a SortedList object. (Inherited from SortedList.)
	IndexOfKey	Returns the zero-based index of the specified key in a SortedList object. (Inherited from SortedList.)
	IndexOfValue	Returns the zero-based index of the first occurrence of the specified value in a SortedList object. (Inherited from SortedList.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the element with the specified key from the IDictionary object. (Overrides SortedListRemove(Object).)
	RemoveAt	Removes the element at the specified index of a SortedList object. (Inherited from SortedList.)
	SetByIndex	Replaces the value at a specific index in a SortedList object. (Inherited from SortedList.)
	ToString	Returns string representation of this instance. (Overrides ObjectToString.)
	TrimToSize	Sets the capacity to the actual number of elements in a SortedList object. (Inherited from SortedList.)

Top

Remarks

Note that null keys support intentionally breaks IDictionary contract, which states that an ArgumentNullException should be raised if the key is null.

However, this is necessary in order to match the behavior in Java and C++, where some Map implementations support null keys.

Note: This implementation is not thread safe. If you need it to be, you should wrap it with the SynchronizedDictionary.

Reference

Tangosol.Util.Collections Namespace