IBijectiveMapConst

Description

interface Tinman.Core.Collections.IBijectiveMapConst
<TLeft>
<TRight>

Extended by

IBijectiveMap

Base interface for classes that represent a read-only bidirectional aka. bijective mapping between left and right value pairs.

Public / Methods

Contains​Left


public method ContainsLeft → (1)

left in : TLeft

The key.

returns → bool

true if the map contains an entry for the key, false if it does not.

Returns if this map contains an entry for the given key.

Contains​Right


public method ContainsRight → (1)

right in : TRight

The key.

returns → bool

true if the map contains an entry for the key, false if it does not.

Returns if this map contains an entry for the given key.

Get​Left


public method GetLeft → (2)

left in : TLeft

The key.

defaultValue opt : TRight = default(TRight)

The default value to return in case the map does not contain an entry for left in.

returns → TRight

The entry value.

Returns the value that is currently mapped to the given key.

Get​Right


public method GetRight → (2)

right in : TRight

The key.

defaultValue opt : TLeft = default(TLeft)

The default value to return in case the map does not contain an entry for right in.

returns → TLeft

The entry value.

Returns the value that is currently mapped to the given key.

Public / Attributes

Count


public attribute Count → (get)

value : int32

[>=0]
The number of map entries.

The number of key/value pairs in the map.

Entries


public attribute Entries → (get)

value : IBagConst<MapEntry<TLeft, TRight>>

[not-null]
The set of key/value pairs.

Returns a read-only set of all key/value pairs in this dictionary.

Keys​Left


public attribute KeysLeft → (get)

value : IBagConst<TLeft>

[not-null]
The set of keys.

Returns a read-only set of all keys in this dictionary.

Keys​Right


public attribute KeysRight → (get)

value : IBagConst<TRight>

[not-null]
The collection of values.

Returns a read-only collection of all values in this dictionary.