EqualityDefinedMap<K, V> class

A Map that has equality defined on it by its entries.

An instance of an equality-defined map inherits all the methods and properties of an Map, but overrides the property hashCode and the operator operator ==.

By default, two equality-defined map are considered equal if they have the same length, and if every entry in the map corresponds to another entry in the other map, where both the key and value of the entry are considered equal by the equality operator operator ==. This is DefaultEquality.

It is also possible to provide a different type of Equality when checking both the keys and the values. A pre-defined alternate is the IdentityEquality, which defines two objects as equal if they are the same instance of an object.

See also:

Inheritance
Available Extensions

Constructors

EqualityDefinedMap(Map<K, V> map, {Equality keyEquality = const DefaultEquality(), Equality valueEquality = const DefaultEquality()})
Creates an equality-defined map.
const

Properties

entries Iterable<MapEntry<K, V>>
The map entries of this.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyoverride
isEmpty bool
Whether there is no key/value pair in the map.
read-onlyinherited
isNotEmpty bool
Whether there is at least one key/value pair in the map.
read-onlyinherited
keyEquality Equality
final
keys Iterable<K>
The keys of this.
read-onlyinherited
length int
The number of key/value pairs in the map.
read-onlyinherited
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
valueEquality Equality
final
values Iterable<V>
The values of this.
read-onlyinherited

Methods

addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry<K, V>> entries) → void
Adds all key/value pairs of newEntries to this map.
inherited
cast<K2, V2>() Map<K2, V2>
Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void
Removes all entries from the map.
inherited
containsKey(Object key) bool
Whether this map contains the given key.
inherited
containsValue(Object value) bool
Whether this map contains the given value.
inherited
forEach(void f(K, V)) → void
Applies action to each key/value pair of the map.
inherited
map<K2, V2>(MapEntry<K2, V2> transform(K, V)) 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 non-existent 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.
inherited
remove(Object key) → V
Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool test(K, V)) → void
Removes all entries of this map that satisfy the given test.
inherited
retype<K2, V2>() Map<K2, V2>
@Deprecated("Use cast instead")inherited
toString() String
A string representation of this object.
inherited
update(K key, V update(V), {V ifAbsent()}) → V
Updates the value for the provided key.
inherited
updateAll(V update(K, V)) → void
Updates all values.
inherited

Operators

operator ==(Object other) bool
The equality operator.
override
operator [](Object key) → V
The value for the given key, or null if key is not in the map.
inherited
operator []=(K key, V value) → void
Associates the key with the given value.
inherited