IMap<TKey,TValue> Interface

Definition

Unit:: Spring.Collections

Package:: Spring.Base

Represents a generic collection of key/value pairs.

Delphi

type IMap<TKey,TValue> = interface(ICollection<TPair<TKey,TValue>>)

Type Parameters

TKey

The type of keys in the map.

TValue

The type of values in the map.

Inheritance: IInterface

IEnumerable<T>

IReadOnlyCollection<T>

ICollection<T>
IMap<TKey,TValue>

Derived: IDictionary<TKey,TValue>

IMultiMap<TKey,TValue>

TBidiDictionary<TKey,TValue>

TDictionary<TKey,TValue>

TInverse

TMultiMap<TKey,TValue>

TSortedDictionary<TKey,TValue>

TSortedMultiMap<TKey,TValue>

Properties

Comparer	Gets the assigned comparer. If no comparer was assigned it returns the default comparer. (Inherited from IEnumerable<T>)
Count	Returns the number of elements in the sequence. (Inherited from IEnumerable<T>)
ElementType	Gets the type of the elements in the sequence. (Inherited from IEnumerable<T>)
IsEmpty	Determines whether the sequence contains no elements. (Inherited from IEnumerable<T>)
KeyType	Gets the type of the key of the elements in the map.
Keys	Gets a collection containing the keys of the map.
OnChanged	Occurs when an item is added, removed, or moved, or the entire list is refreshed. (Inherited from ICollection<T>)
OnKeyChanged
OnValueChanged
ValueType	Gets the type of the value of the elements in the map.
Values	Gets a collection containing the values in the map.

Methods

Add(TKey, TValue)	Adds an element with the specified key and value to the collection.
AddRange(IEnumerable<T>)	Adds multiple items to the collection. (Inherited from ICollection<T>)
Aggregate(Func<T,T,T>)	Applies an accumulator function over the sequence. (Inherited from IEnumerable<T>)
All(Predicate<T>)	Determines whether all elements of the sequence satisfy a condition. (Inherited from IEnumerable<T>)
Any(Predicate<T>)	Determines whether any element of the sequence satisfies a condition. (Inherited from IEnumerable<T>)
AsObject	Returns the reference to this instance. (Inherited from IEnumerable<T>)
AtLeast(Integer)	Determines whether or not the number of elements in the sequence is greater than or equal to the given count. (Inherited from IEnumerable<T>)
AtMost(Integer)	Determines whether or not the number of elements in the sequence is lesser than or equal to the given count. (Inherited from IEnumerable<T>)
Average(Func<T,Currency>)	Computes the average of a sequence of Currency values that are obtained by invoking a transform function on each element of the input sequence. (Inherited from IEnumerable<T>)
Between(Integer, Integer)	Determines whether or not the number of elements in the sequence is between an inclusive range of minimum and maximum integers. (Inherited from IEnumerable<T>)
Clear	Removes all items from the collection. (Inherited from ICollection<T>)
Concat(IEnumerable<T>)	Concatenates two sequences. (Inherited from IEnumerable<T>)
Contains(T, TEqualityComparison<T>)	Determines whether the sequence contains a specified element by using a specified equality comparison. (Inherited from IEnumerable<T>)
Contains(TKey, TValue)	Determines whether the map contains an element with the specified key/value pair.
ContainsKey(TKey)	Determines whether the map contains an element with the specified key.
ContainsValue(TValue)	Determines whether the map contains an element with the specified value.
CopyTo(TArray<T>, Integer)	Copies the elements of the collection to an array, starting at a particular array index. (Inherited from IReadOnlyCollection<T>)
DefaultIfEmpty(T)	Returns the elements of the sequence or the specified default value in sequence if the sequence is empty. (Inherited from IEnumerable<T>)
Distinct(IEqualityComparer<T>)	Returns distinct elements from the sequence by using a specified equality comparer to compare values. (Inherited from IEnumerable<T>)
ElementAt(Integer)	Returns the element at a specified index in the sequence. (Inherited from IEnumerable<T>)
ElementAtOrDefault(Integer, T)	Returns the element at a specified index in the sequence or the specified default value if the index is out of range. (Inherited from IEnumerable<T>)
EqualsTo(IEnumerable<T>, IEqualityComparer<T>)	Determines whether two sequences are equal by comparing their elements by using a specified equality comparer. (Inherited from IEnumerable<T>)
Exactly(Integer)	Determines whether or not the number of elements in the sequence is equals to the given count. (Inherited from IEnumerable<T>)
Exclude(IEnumerable<T>, IEqualityComparer<T>)	Produces the set difference of two sequences by using the specified equality comparer to compare values. (Inherited from IEnumerable<T>)
Extract(TKey, TValue)	Removes the element associated with the specified key if it matches the specified value without triggering lifetime management for objects.
ExtractAll(Predicate<T>)	Removes all the elements that match the conditions defined by the specified predicate without triggering lifetime management for objects. (Inherited from ICollection<T>)
ExtractRange(IEnumerable<T>)	Removes the first occurrence of each element from the collection without triggering lifetime management for objects. (Inherited from ICollection<T>)
First(Predicate<T>)	Returns the first element in the sequence that satisfies a specified condition. (Inherited from IEnumerable<T>)
FirstOrDefault(Predicate<T>, T)	Returns the first element of the sequence that satisfies the specified condition or the specified default value if no such element is found. (Inherited from IEnumerable<T>)
ForEach(Action<T>)	Performs the specified action on each element of the sequence. (Inherited from IEnumerable<T>)
GetComparer	Returns the specified comparer for this instance. (Inherited from IEnumerable<T>)
GetCount	(Inherited from IEnumerable<T>)
GetElementType	(Inherited from IEnumerable<T>)
GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from IEnumerable<T>)
GetIsEmpty	(Inherited from IEnumerable<T>)
GetKeyType
GetKeys
GetNonEnumeratedCount	Attempts to determine the number of elements in the sequence without forcing an enumeration. (Inherited from IEnumerable<T>)
GetOnChanged	(Inherited from ICollection<T>)
GetOnKeyChanged
GetOnValueChanged
GetValueType
GetValues
Intersect(IEnumerable<T>, IEqualityComparer<T>)	Produces the set intersection of two sequences by using the specified equality comparer to compare values. (Inherited from IEnumerable<T>)
Last(Predicate<T>)	Returns the last element of the sequence that satisfies the specified condition. (Inherited from IEnumerable<T>)
LastOrDefault(Predicate<T>, T)	Returns the last element of the sequence that satisfies the specified condition or the specified default value if no such element is found. (Inherited from IEnumerable<T>)
Max(TComparison<T>)	Returns the maximum value in the sequence by using the specified comparison. (Inherited from IEnumerable<T>)
Memoize	Returns a sequence that lazily caches the sequence as it is iterated for the first time, reusing the cache thereafter for future re-iterations. If the sequence is already cached or buffered then it is returned verbatim. (Inherited from IEnumerable<T>)
Min(TComparison<T>)	Returns the minimum value in the sequence by using the specified comparison. (Inherited from IEnumerable<T>)
MoveTo(ICollection<T>, Predicate<T>)	Moves the elements of the collection that are matching the specified predicate to the specified collection. (Inherited from ICollection<T>)
Ordered(TComparison<T>)	Sorts the elements of the sequence in ascending order using the specified comparison. (Inherited from IEnumerable<T>)
Remove(TKey)	Removes the element with the specified key from the collection.
Remove(TKey, TValue)	Removes the element with the specified key and value from the collection.
RemoveAll(Predicate<T>)	Removes all the elements that match the conditions defined by the specified predicate. (Inherited from ICollection<T>)
RemoveRange(IEnumerable<T>)	Removes the first occurrence of each element from the collection. (Inherited from ICollection<T>)
RemoveRange(IEnumerable<TKey>)	Removes the elements with the specified keys from the collection.
RemoveRange(array of TKey)	Removes the elements with the specified keys from the collection.
Reversed	Inverts the order of the elements in the sequence. (Inherited from IEnumerable<T>)
Shuffled	Returns a sequence of elements in random order from the original. (Inherited from IEnumerable<T>)
Single(Predicate<T>)	Returns the only element of the sequence that satisfies a specified condition, and raises an exception if more than one such element exists. (Inherited from IEnumerable<T>)
SingleOrDefault(Predicate<T>, T)	Returns the only element of the sequence that satisfies a specified condition, or a specified default value if no such element exists; this method raises an exception if more than one element satisfies the condition. (Inherited from IEnumerable<T>)
Skip(Integer)	Bypasses a specified number of elements in the sequence and then returns the remaining elements. (Inherited from IEnumerable<T>)
SkipLast(Integer)	Omits the specified number of elements at the end of the sequence. (Inherited from IEnumerable<T>)
SkipWhile(Func<T,Integer,Boolean>)	Bypasses elements in the sequence as long as a specified condition is true and then returns the remaining elements. The element's index is used in the logic of the predicate function. (Inherited from IEnumerable<T>)
Sum(Func<T,Currency>)	Computes the sum of the sequence of Currency values that are obtained by invoking a transform function on each element of the input sequence. (Inherited from IEnumerable<T>)
Take(Integer)	Returns the specified number of contiguous elements from the start of the sequence. (Inherited from IEnumerable<T>)
TakeLast(Integer)	Returns the specified number of contiguous elements from the end of the sequence. (Inherited from IEnumerable<T>)
TakeWhile(Func<T,Integer,Boolean>)	Returns elements from the sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function. (Inherited from IEnumerable<T>)
ToArray	Creates a new array which is filled with the elements in the collection. (Inherited from IEnumerable<T>)
TryAdd(TKey, TValue)	Attempts to add an element with the specified key and value to the collection.
TryGetElementAt(T, Integer)	Attempts to get the element at a specified index in the sequence. (Inherited from IEnumerable<T>)
TryGetFirst(T, Predicate<T>)	Attempts to get the first element in the sequence that satisfies a specified condition. (Inherited from IEnumerable<T>)
TryGetLast(T, Predicate<T>)	Attempts to get the last element in the sequence that satisfies a specified condition. (Inherited from IEnumerable<T>)
TryGetSingle(T, Predicate<T>)	Attempts to get the only element in the sequence that satisfies a specified condition. (Inherited from IEnumerable<T>)
Union(IEnumerable<T>, IEqualityComparer<T>)	Produces the set union of two sequences by using a specified equality comparer. (Inherited from IEnumerable<T>)
Where(Func<T,Integer,Boolean>)	Filters the sequence based on the specified predicate. Each element's index is used in the logic of the predicate function. (Inherited from IEnumerable<T>)