ModifiableMapFromIMap<K, V> class

The ModifiableMapFromIMap is a safe, modifiable Map that is built from an IMap. The construction of the map is fast at first, since it makes no copies of the IMap items, but just uses it directly.

If and only if you use a method that mutates the map, like add, it will unlock internally (make a copy of all IMap items). This is transparent to you, and will happen at most only once. In other words, it will unlock the IMap, lazily, only if necessary.

If you never mutate the map, it will be very fast to lock this map back into an IMap.

See also: UnmodifiableMapFromIMap

Implemented types

• Map<K, V>
• CanBeEmpty

Mixed-in types

• MapMixin<K, V>

Available extensions

• ElementalOnMap
• FicMapExtension
• FicMapOfSetsExtension

Constructors

ModifiableMapFromIMap.new(IMap<K, V>? imap)

Properties

entries → Iterable<MapEntry<K, V>>

The map entries of this Map.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isEmpty → bool

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

no setter, inherited

isNotEmpty → bool

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

no setter, inherited

keys → Iterable<K>

The keys of this Map.

no setter, override

length → int

The number of key/value pairs in the map.

no setter, inherited

lock → IMap<K, V>

no setter

lock → IMap<K, V>

Available on Map<K, V>, provided by the FicMapExtension extension

Locks the map, returning an immutable map (IMap).

no setter

lock → IMapOfSets<K, V>

Available on Map<K, Set<V>>, provided by the FicMapOfSetsExtension extension

Locks the map of sets, returning an immutable map (IMapOfSets).

no setter

lockUnsafe → IMap<K, V>

Available on Map<K, V>, provided by the FicMapExtension extension

Locks the map, returning an immutable map (IMap).

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

size → int

Available on Map<K, V>, provided by the ElementalOnMap extension

Return number of elements in the Map (keys.length).

no setter

values → Iterable<V>

The values of this Map.

no setter, inherited

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

collect<A>(Order<K> order, A compose(K key, V value)) → Iterable<A>

Available on Map<K, V>, provided by the ElementalOnMap extension

Collect all the entries in this Map into an Iterable using compose, with the values ordered using order.

containsKey(Object? key) → bool

Whether this map contains the given key.

inherited

containsValue(Object? value) → bool

Whether this map contains the given value.

inherited

extract<T>(K key) → Option<T>

Available on Map<K, V>, provided by the ElementalOnMap extension

Return an Option that conditionally accesses map keys, only if they match the given type.

extractMap(K key) → Option<Map<K, dynamic>>

Available on Map<K, V>, provided by the ElementalOnMap extension

Return an Option that conditionally accesses map keys if they contain a value with a Map value.

filter(bool test(V value)) → Map<K, V>

Available on Map<K, V>, provided by the ElementalOnMap extension

Returns a new Map containing all the elements of this Map where the value satisfies test.

filterWithIndex(bool test(V value, int index)) → Map<K, V>

Available on Map<K, V>, provided by the ElementalOnMap extension

Returns a new Map containing all the elements of this Map where the value satisfies test.

filterWithKey(bool test(K key, V value)) → Map<K, V>

Available on Map<K, V>, provided by the ElementalOnMap extension

Returns a new Map containing all the elements of this Map where key/value satisfies test.

filterWithKeyAndIndex(bool test(K key, V value, int index)) → Map<K, V>

Available on Map<K, V>, provided by the ElementalOnMap extension

Returns a new Map containing all the elements of this Map where key/value satisfies test.

foldLeft<A>(Order<K> order, A initial, A compose(A acc, V value)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on order on their key, and return the result of combining all the intermediate values.

foldLeftWithIndex<A>(Order<K> order, A initial, A compose(A acc, V value, int index)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on order on their key, passing also the current index of the iteration, and return the result of combining all the intermediate values.

foldLeftWithKey<A>(Order<K> order, A initial, A compose(A acc, K key, V value)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on order on their key, and return the result of combining all the intermediate values.

foldLeftWithKeyAndIndex<A>(Order<K> order, A initial, A compose(A acc, K key, V value, int index)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on order on their key, passing also the current index of the iteration, and return the result of combining all the intermediate values.

foldRight<A>(Order<K> order, A initial, A compose(V value, A acc)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on the inverse of order on their key, and return the result of combining all the intermediate values.

foldRightWithIndex<A>(Order<K> order, A initial, A compose(V value, A acc, int index)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on the inverse of order on their key, passing also the current index of the iteration, and return the result of combining all the intermediate values.

foldRightWithKey<A>(Order<K> order, A initial, A compose(K key, V value, A acc)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on the inverse of order on their key, and return the result of combining all the intermediate values.

foldRightWithKeyAndIndex<A>(Order<K> order, A initial, A compose(K key, V value, A acc, int index)) → A

Available on Map<K, V>, provided by the ElementalOnMap extension

Apply compose to all the values of this Map sorted based on the inverse of order on their key, passing also the current index of the iteration, and return the result of combining all the intermediate values.

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

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

inherited

lookup(K key) → Option<V>

Available on Map<K, V>, provided by the ElementalOnMap extension

Get the value at given key if present, otherwise return None.

lookupWithKey(K key) → Option<(K, V)>

Available on Map<K, V>, provided by the ElementalOnMap extension

Get the value and key at given key if present, otherwise return None.

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

mapTo<T>(T mapper(K key, V value)) → Iterable<T>

Available on Map<K, V>, provided by the FicMapExtension extension

Returns a new lazy Iterable with elements that are created by calling mapper on each entry of this Map in iteration order.

mapValue<A>(A update(V value)) → Map<K, A>

Available on Map<K, V>, provided by the ElementalOnMap extension

Convert each value of the Map using the update function and returns a new Map.

mapWithIndex<A>(A update(V value, int index)) → Map<K, A>

Available on Map<K, V>, provided by the ElementalOnMap extension

Convert each value of the Map using the update function and returns a new Map.

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.

inherited

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

toIMap([ConfigMap? config]) → IMap<K, V>

Available on Map<K, V>, provided by the FicMapExtension extension

Creates an immutable map (IMap) from the map.

toIMapOfSets([ConfigMapOfSets? config]) → IMapOfSets<K, V>?

Available on Map<K, Set<V>>, provided by the FicMapOfSetsExtension extension

Creates an immutable map of sets (IMapOfSets) from the map.

toSortedList(Order<K> order) → List<MapEntry<K, V>>

Available on Map<K, V>, provided by the ElementalOnMap extension

Get a sorted List of the key/value pairs contained in this Map based on order on keys.

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