BiMap<K, V> class

A bi-map associates keys with values and values with keys.

Bi-maps behave like maps from key to values, but can efficiently provide an inverse bi-map that maps values to keys. Also certain operations, such as containsValue are much more efficient than with traditional maps.

Inheritance

• Object
• MapBase<K, V>
• BiMap

Available Extensions

• BiMapOnMapExtension
• DefaultMapExtension
• ListMultimapOnMapExtension
• SetMultimapOnMapExtension

Constructors

BiMap()

Creates an empty bi-map.

factory

BiMap.from(Map<K, V> other)

Creates bi-map from another map.

factory

BiMap.fromIterable(Iterable<Object?> iterable, {K key(Object? element)?, V value(Object? element)?})

Creates a bi-map from an iterable (and possible transformation functions).

factory

BiMap.fromIterables(Iterable<K> keys, Iterable<V> values)

Creates a bi-map from two equal length iterables.

factory

BiMap.identity()

Creates an empty identity bi-map.

factory

BiMap.of(Map<K, V> other)

Creates bi-map from another map.

factory

Properties

backward → Map<V, K>

Returns a backward map onto the same data. This accessor effectively returns the same as BiMap.inverse, but case-down to a Map.

no setter

entries → Iterable<MapEntry<K, V>>

The map entries of this.

no setter, inherited

forward → Map<K, V>

Returns a forward map onto the same data. This accessor effectively returns this object, but cast-down to a Map.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

inverse → BiMap<V, K>

Returns the inverse bi-map onto the same data.

no setter

isEmpty → bool

Whether there is no key/value pair in the map.

no setter, override

isNotEmpty → bool

Whether there is at least one key/value pair in the map.

no setter, override

keys → Iterable<K>

The keys of this.

no setter, override

length → int

The number of key/value pairs in the map.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

values → Iterable<V>

The values of this.

no setter, override

Methods

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 entries from the map.

override

containsKey(Object? key) → bool

Whether this map contains the given key.

override

containsValue(Object? value) → bool

Whether this map contains the given value.

override

forEach(void action(K key, V value)) → void

Applies action to each key/value pair of the map.

override

map<K2, V2>(MapEntry<K2, V2> transform(K key, V value)) → Map<K2, V2>

Returns a new map where all entries of this map are transformed by the given convert function.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putIfAbsent(K key, V ifAbsent()) → V

Look up the value of key, or add a new entry if it isn't there.

override

remove(Object? key) → V?

Removes key and its associated value, if present, from the map.

override

removeWhere(bool test(K key, V value)) → void

Removes all entries of this map that satisfy the given test.

inherited

toString() → String

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 ==(Object other) → bool

The equality operator.

inherited

operator [](Object? key) → V?

The value for the given key, or null if key is not in the map.

override

operator []=(K key, V value) → void

Associates the key with the given value.

override