ObsMap<K, V> class

Observable reactive map.

Behaves like a wrapper around Map with its changes exposed.

Inheritance
Implemented types
Available extensions

Constructors

ObsMap([Map<K, V>? initial])
Creates a LinkedHashMap with initial keys and values.
ObsMap.from(Map other)
Creates a LinkedHashMap with the same keys and values as other.
factory
ObsMap.fromEntries(Iterable<MapEntry<K, V>> entries)
Creates a new map and adds all the provided entries to it.
factory
ObsMap.fromIterable(Iterable iterable, {K key(dynamic element)?, V value(dynamic element)?})
Creates a Map instance in which the keys and values are computed from the iterable.
factory
ObsMap.fromIterables(Iterable<K> keys, Iterable<V> values)
Creates a map associating the given keys to the given values.
factory
ObsMap.of(Map<K, V> other)
Creates a LinkedHashMap with the same keys and values as other.
factory
ObsMap.unmodifiable(ObsMap<K, V> other)
Creates an unmodifiable hash-based map containing the entries of other.
factory

Properties

changes → Stream<MapChangeNotification<K, V>>
Returns stream of record of changes of this ObsMap.
no setter
entries → Iterable<MapEntry<K, V>>
The map entries of this Map.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Whether there is no key/value pair in the map.
no setterinherited
isNotEmpty → bool
Whether there is at least one key/value pair in the map.
no setterinherited
keys → Iterable<K>
The keys of this Map.
no setterinherited
length → int
The number of key/value pairs in the map.
no setterinherited
obs → RxMap<K, V>

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

no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
values → Iterable<V>
The values of this Map.
no setterinherited

Methods

addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map.
override
addAllIf(dynamic condition, Map<K, V> values) → void

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

addEntries(Iterable<MapEntry<K, V>> entries) → void
Adds all key/value pairs of newEntries to this map.
override
addIf(dynamic condition, K key, V value) → void

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

assign(K key, V val) → void

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

assignAll(Map<K, V> val) → void

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

build() → BuiltMap<K, V>

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

Converts to a BuiltMap.
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.
override
containsKey(Object? key) → bool
Whether this map contains the given key.
inherited
containsValue(Object? value) → bool
Whether this map contains the given value.
inherited
emit(MapChangeNotification<K, V> event) → void
Emits a new event.
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
move(K oldKey, K newKey) → void
Moves the element at the oldKey to the newKey replacing the existing element, if any.
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, V)) → void
Removes all entries of this map that satisfy the given test.
inherited
retype<K2, V2>() → Map<K2, V2>
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.
inherited
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.
override