ImmutableDictionary<TKey, TValue> Class

A dictionary that can be modified until IsReadOnly is set to true. Once this occurs, the dictionary itself can no longer be modified. Remember, this does not cause objects contained in this class to be Immutable unless they implement IImmutableObject.

Inheritance Hierarchy

System.Object
GSF.Immutable.ImmutableObjectBase<ImmutableDictionary<TKey, TValue> >
GSF.Immutable.ImmutableDictionary<TKey, TValue>

Namespace: GSF.Immutable
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.241-beta+912389e96d98840d2a999d490420db618dcbe4c6

Syntax

C++

JavaScript

Copy

public sealed class ImmutableDictionary<TKey, TValue> : ImmutableObjectBase<ImmutableDictionary<TKey, TValue>>, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

Public NotInheritable Class ImmutableDictionary(Of TKey, TValue)
	Inherits ImmutableObjectBase(Of ImmutableDictionary(Of TKey, TValue))
	Implements IDictionary(Of TKey, TValue), ICollection(Of KeyValuePair(Of TKey, TValue)), 
	IEnumerable(Of KeyValuePair(Of TKey, TValue)), IEnumerable

generic<typename TKey, typename TValue>
public ref class ImmutableDictionary sealed : public ImmutableObjectBase<ImmutableDictionary<TKey, TValue>^>, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

[<SealedAttribute>]
type ImmutableDictionary<'TKey, 'TValue> = 
    class
        inherit ImmutableObjectBase<ImmutableDictionary<'TKey, 'TValue>>
        interface IDictionary<'TKey, 'TValue>
        interface ICollection<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

TKey
TValue

The ImmutableDictionary<TKey, TValue> type exposes the following members.

Constructors

	Name	Description
	ImmutableDictionary<TKey, TValue>()	Creates a new ImmutableDictionary<TKey, TValue>.
	ImmutableDictionary<TKey, TValue>(Dictionary<TKey, TValue>)	Creates a new ImmutableDictionary<TKey, TValue>.
	ImmutableDictionary<TKey, TValue>(Int32)	Creates a new ImmutableDictionary<TKey, TValue>.

Top

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollection<T>.
	IsReadOnly	Gets/Sets if this class is immutable and thus read only. Once setting to readonly, the class becomes immutable. (Inherited from ImmutableObjectBase<T>)
	Item	Gets or sets the element with the specified key.
	Keys	Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>.
	Values	Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>.

Top

Methods

	Name	Description
	Add	Adds an element with the provided key and value to the IDictionary<TKey, TValue>.
	Clear	Removes all items from the ICollection<T>.
	Clone	Returns a clone of this class. If the class is marked as readonly, it returns the current instance. (Inherited from ImmutableObjectBase<T>)
	CloneEditable	Creates a clone of this class that is editable. A clone is always created, even if this class is already editable. (Inherited from ImmutableObjectBase<T>)
	CloneReadonly	Makes a readonly clone of the object. If the class is currently marked as readonly, the current instance is returned. (Inherited from ImmutableObjectBase<T>)
	Contains	Determines whether the ICollection<T> contains a specific value.
	ContainsKey	Determines whether the IDictionary<TKey, TValue> contains an element with the specified key.
	CopyTo	Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Remove(TKey)	Removes the element with the specified key from the IDictionary<TKey, TValue>.
	Remove(KeyValuePair<TKey, TValue>)	Removes the first occurrence of a specific object from the ICollection<T>.
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetValue	Gets the value associated with the specified key.

Top

Extension Methods

	Name	Description
	AllParallel<KeyValuePair<TKey, TValue>>	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctBy<KeyValuePair<TKey, TValue>, TKey>	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefault<T>	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	Majority<KeyValuePair<TKey, TValue>>	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	Majority<KeyValuePair<TKey, TValue>>	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityBy<KeyValuePair<TKey, TValue>, TKey>	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityBy<KeyValuePair<TKey, TValue>, TKey>	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	Max<KeyValuePair<TKey, TValue>>	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	Max<KeyValuePair<TKey, TValue>>	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxBy<KeyValuePair<TKey, TValue>, TKey>	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	Median<KeyValuePair<TKey, TValue>>	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	Middle<KeyValuePair<TKey, TValue>>	Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	Min<KeyValuePair<TKey, TValue>>	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	Min<KeyValuePair<TKey, TValue>>	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinBy<KeyValuePair<TKey, TValue>, TKey>	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	Minority<KeyValuePair<TKey, TValue>>	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	Minority<KeyValuePair<TKey, TValue>>	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityBy<KeyValuePair<TKey, TValue>, TKey>	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityBy<KeyValuePair<TKey, TValue>, TKey>	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	StandardDeviation<KeyValuePair<TKey, TValue>>	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviation<KeyValuePair<TKey, TValue>>	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviation<KeyValuePair<TKey, TValue>>	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedString<KeyValuePair<TKey, TValue>>	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedString<KeyValuePair<TKey, TValue>>	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedString<KeyValuePair<TKey, TValue>>	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedList<KeyValuePair<TKey, TValue>>	Gets a PagedList<T> to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)

Top

Reference

GSF.Immutable Namespace