CanonicalizedMap<C, K, V> class
A map whose keys are converted to canonical values of type C.
This is useful for using case-insensitive String keys, for example. It's more efficient than a LinkedHashMap with a custom equality operator because it only canonicalizes each key once, rather than doing so for each comparison.
- Implemented types
-
- Map<
K, V>
- Map<
Constructors
- CanonicalizedMap(C canonicalize(K key), {bool isValidKey(K key)?})
- Creates an empty canonicalized map.
-
CanonicalizedMap.from(Map<
K, V> other, C canonicalize(K key), {bool isValidKey(K key)?}) -
Creates a canonicalized map that is initialized with the key/value pairs
of
other. -
CanonicalizedMap.fromEntries(Iterable<
MapEntry< entries, C canonicalize(K key), {bool isValidKey(K key)?})K, V> > -
Creates a canonicalized map that is initialized with the key/value pairs
of
entries.
Properties
-
entries
→ Iterable<
MapEntry< K, V> > -
The map entries of this Map.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- isEmpty → bool
-
Whether there is no key/value pair in the map.
no setteroverride
- isNotEmpty → bool
-
Whether there is at least one key/value pair in the map.
no setteroverride
-
keys
→ Iterable<
K> -
The keys of this Map.
no setteroverride
- length → int
-
The number of key/value pairs in the map.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
values
→ Iterable<
V> -
The values of this Map.
no setteroverride
Methods
-
addAll(
Map< K, V> other) → void -
Adds all key/value pairs of
otherto this map.override -
addEntries(
Iterable< MapEntry< entries) → voidK, V> > -
Adds all key/value pairs of
newEntriesto this map.override -
cast<
K2, V2> () → Map< K2, V2> -
Provides a view of this map as having
RKkeys andRVinstances, if necessary.override -
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 -
copy(
) → CanonicalizedMap< C, K, V> - Copies this CanonicalizedMap instance without recalculating the canonical values of the keys.
-
forEach(
void f(K, V)) → void -
Applies
actionto each key/value pair of the map.override -
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
convertfunction.override -
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
keyand 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.override -
retype<
K2, V2> () → Map< K2, V2> -
toMap(
) → Map< K, V> -
Creates a
Map<K,V>(with the original key values). See toMapOfCanonicalKeys. -
toMapOfCanonicalKeys(
) → Map< C, V> -
Creates a
Map<C,V>(with the canonicalized keys). See toMap. -
toString(
) → String -
A string representation of this object.
override
-
update(
K key, V update(V), {V ifAbsent()?}) → V -
Updates the value for the provided
key.override -
updateAll(
V update(K key, V value)) → void -
Updates all values.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
Object? key) → V? -
The value for the given
key, ornullifkeyis not in the map.override -
operator []=(
K key, V value) → void -
Associates the
keywith the givenvalue.override