ImmutableDictionaryTKey, 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

SystemObject
GSF.ImmutableImmutableObjectBaseImmutableDictionaryTKey, TValue
GSF.ImmutableImmutableDictionaryTKey, TValue

Namespace: GSF.Immutable
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta

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 ImmutableDictionaryTKey, TValue type exposes the following members.

Constructors

	Name	Description
	ImmutableDictionaryTKey, TValue	Creates a new ImmutableDictionaryTKey, TValue.
	ImmutableDictionaryTKey, TValue(DictionaryTKey, TValue)	Creates a new ImmutableDictionaryTKey, TValue.
	ImmutableDictionaryTKey, TValue(Int32)	Creates a new ImmutableDictionaryTKey, TValue.

Top

Properties

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

Top

Methods

	Name	Description
	Add	Adds an element with the provided key and value to the IDictionaryTKey, TValue.
	Clear	Removes all items from the ICollectionT.
	Clone	Returns a clone of this class. If the class is marked as readonly, it returns the current instance. (Inherited from ImmutableObjectBaseT)
	CloneEditable	Creates a clone of this class that is editable. A clone is always created, even if this class is already editable. (Inherited from ImmutableObjectBaseT)
	CloneReadonly	Makes a readonly clone of the object. If the class is currently marked as readonly, the current instance is returned. (Inherited from ImmutableObjectBaseT)
	Contains	Determines whether the ICollectionT contains a specific value.
	ContainsKey	Determines whether the IDictionaryTKey, TValue contains an element with the specified key.
	CopyTo	Copies the elements of the ICollectionT 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 IDictionaryTKey, TValue.
	Remove(KeyValuePairTKey, TValue)	Removes the first occurrence of a specific object from the ICollectionT.
	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
	AllParallelKeyValuePairTKey, TValue	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByKeyValuePairTKey, 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)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	MajorityKeyValuePairTKey, TValue	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityKeyValuePairTKey, TValue	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByKeyValuePairTKey, TValue, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByKeyValuePairTKey, TValue, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxKeyValuePairTKey, TValue	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxKeyValuePairTKey, TValue	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByKeyValuePairTKey, TValue, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianKeyValuePairTKey, TValue	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinKeyValuePairTKey, TValue	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinKeyValuePairTKey, TValue	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByKeyValuePairTKey, TValue, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityKeyValuePairTKey, TValue	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityKeyValuePairTKey, TValue	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByKeyValuePairTKey, TValue, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByKeyValuePairTKey, TValue, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationKeyValuePairTKey, TValue	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringKeyValuePairTKey, 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)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringKeyValuePairTKey, TValue	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListKeyValuePairTKey, TValue	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)

Top

Reference

GSF.Immutable Namespace