ImmutableLinkedHashMap<K, V> Class

Namespace:: Maroontress.Collection

Assembly:: Collection.dll

This class implements the IImmutableDictionary<TKey, TValue> interface. It has ImmutableDictionary<TKey, TValue> and ImmutableArray<T> to maintain the elements so that it has predictable iteration order, like that of the LinkedHashMap class in Java.

public sealed class ImmutableLinkedHashMap<K, V> : IImmutableDictionary<K, V>
    where K : notnull

Type Parameters

K: notnull

The type of keys maintained by this dictionary.

V

The type of mapped values.

Inheritance: object
ImmutableLinkedHashMap<K, V>

Implements: IImmutableDictionary<K, V> IReadOnlyDictionary<K, V> IReadOnlyCollection<KeyValuePair<K, V>> IEnumerable<KeyValuePair<K, V>> IEnumerable

Remarks

The ImmutableArray<T> keeps the iteration order corresponding to the in which you insert key-value pairs into the map. Note that the insertion order is not affected when you re-inserted any key into it (i.e., with the SetItem(K, V) method).

Fields

Empty

Gets an empty ImmutableLinkedHashMap<K, V>.

Properties

Keys
Values
Count
this[K]

Methods

Add(K, V)
AddRange(IEnumerable<KeyValuePair<K, V>>)
Clear()
Contains(KeyValuePair<K, V>)
ContainsKey(K)
GetEnumerator()
Remove(K)
RemoveRange(IEnumerable<K>)
SetItem(K, V)
SetItems(IEnumerable<KeyValuePair<K, V>>)
TryGetKey(K, K)
TryGetValue(K, V)
Equals(object)	(Inherited from object)
GetHashCode()	(Inherited from object)
GetType()	(Inherited from object)
MemberwiseClone()	(Inherited from object)
ToString()	(Inherited from object)

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Fields Detail

Empty

Gets an empty ImmutableLinkedHashMap<K, V>.

public static readonly ImmutableLinkedHashMap<K, V> Empty

Field Value

ImmutableLinkedHashMap<K, V>

Properties Detail

Keys

public IEnumerable<K> Keys { get; }

Property Value

IEnumerable<K>

Implements

IReadOnlyDictionary<TKey, TValue>.Keys

Values

public IEnumerable<V> Values { get; }

Property Value

IEnumerable<V>

Implements

IReadOnlyDictionary<TKey, TValue>.Values

Count

public int Count { get; }

Property Value

int

Implements

IReadOnlyCollection<T>.Count

this[K]

public V this[K key] { get; }

Property Value

Implements

IReadOnlyDictionary<TKey, TValue>.this[TKey]

Methods Detail

Add(K, V)

public IImmutableDictionary<K, V> Add(K key, V value)

Parameters

key: K

value: V

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.Add(TKey, TValue)

AddRange(IEnumerable<KeyValuePair<K, V>>)

public IImmutableDictionary<K, V> AddRange(IEnumerable<KeyValuePair<K, V>> pairs)

Parameters

pairs: IEnumerable<KeyValuePair<K, V>>

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.AddRange(IEnumerable<KeyValuePair<TKey, TValue>>)

Clear()

public IImmutableDictionary<K, V> Clear()

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.Clear()

Contains(KeyValuePair<K, V>)

public bool Contains(KeyValuePair<K, V> pair)

Parameters

pair: KeyValuePair<K, V>

Returns

bool

Implements

IImmutableDictionary<TKey, TValue>.Contains(KeyValuePair<TKey, TValue>)

ContainsKey(K)

public bool ContainsKey(K key)

Parameters

key: K

Returns

bool

Implements

IReadOnlyDictionary<TKey, TValue>.ContainsKey(TKey)

GetEnumerator()

public IEnumerator<KeyValuePair<K, V>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<K, V>>

Implements

IEnumerable<T>.GetEnumerator()

Remove(K)

public IImmutableDictionary<K, V> Remove(K key)

Parameters

key: K

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.Remove(TKey)

RemoveRange(IEnumerable<K>)

public IImmutableDictionary<K, V> RemoveRange(IEnumerable<K> keys)

Parameters

keys: IEnumerable<K>

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.RemoveRange(IEnumerable<TKey>)

SetItem(K, V)

public IImmutableDictionary<K, V> SetItem(K key, V value)

Parameters

key: K

value: V

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.SetItem(TKey, TValue)

SetItems(IEnumerable<KeyValuePair<K, V>>)

public IImmutableDictionary<K, V> SetItems(IEnumerable<KeyValuePair<K, V>> items)

Parameters

items: IEnumerable<KeyValuePair<K, V>>

Returns

IImmutableDictionary<K, V>

Implements

IImmutableDictionary<TKey, TValue>.SetItems(IEnumerable<KeyValuePair<TKey, TValue>>)

TryGetKey(K, K)

public bool TryGetKey(K equalKey, out K actualKey)

Parameters

equalKey: K

actualKey: K

Returns

bool

Implements

IImmutableDictionary<TKey, TValue>.TryGetKey(TKey, TKey)

TryGetValue(K, V)

public bool TryGetValue(K key, out V value)

Parameters

key: K

value: V

Returns

bool

Implements

IReadOnlyDictionary<TKey, TValue>.TryGetValue(TKey, TValue)

Explicit Interface Implementations Detail

IEnumerable.GetEnumerator()

private IEnumerator IEnumerable.GetEnumerator()

Returns

IEnumerator

Implements

IEnumerable.GetEnumerator()