BiMap<K, V> class

A bi-directional map whose key-value pairs form a one-to-one correspondence. BiMaps support an inverse property which gives access to an inverted view of the map, such that there is a mapping (v, k) for each pair (k, v) in the original map. Since a one-to-one key-value invariant applies, it is an error to insert duplicate values into this map. It is also an error to insert null keys or values into this map.

Implemented types
Implementers

Constructors

BiMap()
Creates a BiMap instance with the default implementation.
factory

Properties

inverse → BiMap<V, K>
Returns the inverse of this map, with key-value pairs (v, k) for each pair (k, v) in this map.
read-only
entries → Iterable<MapEntry<K, V>>
The map entries of this.
read-only, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
isEmpty → bool
Returns true if there is no key/value pair in the map.
read-only, inherited
isNotEmpty → bool
Returns true if there is at least one key/value pair in the map.
read-only, inherited
keys → Iterable<K>
The keys of this. [...]
read-only, inherited
length → int
The number of key/value pairs in the map.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
values → Iterable<V>
The values of this. [...]
read-only, inherited

Methods

replace(K key, V value) → void
Replaces any existing associations(s) involving key and value. [...]
addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map. [...]
inherited
addEntries(Iterable<MapEntry<K, V>> newEntries) → void
Adds all key/value pairs of newEntries to this map. [...]
inherited
cast<RK, RV>() → Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary. [...]
inherited
clear() → void
Removes all pairs from the map. [...]
inherited
containsKey(Object key) → bool
Returns true if this map contains the given key. [...]
inherited
containsValue(Object value) → bool
Returns true if this map contains the given value. [...]
inherited
forEach(void f(K key, V value)) → void
Applies f to each key/value pair of the map. [...]
inherited
map<K2, V2>(MapEntry<K2, V2> f(K key, V value)) → Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given f function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
putIfAbsent(K key, V ifAbsent()) → V
Look up the value of key, or add a new value if it isn't there. [...]
inherited
remove(Object key) → V
Removes key and its associated value, if present, from the map. [...]
inherited
removeWhere(bool predicate(K key, V value)) → void
Removes all entries of this map that satisfy the given predicate.
inherited
toString() → String
Returns a string representation of this object.
inherited
update(K key, V update(V value), { V ifAbsent() }) → V
Updates the value for the provided key. [...]
inherited
updateAll(V update(K key, V value)) → void
Updates all values. [...]
inherited

Operators

operator []=(K key, V value) → void
Adds an association between key and value. [...]
override
operator ==(dynamic other) → bool
The equality operator. [...]
inherited
operator [](Object key) → V
Returns the value for the given key or null if key is not in the map. [...]
inherited