ObservableMap<K, V> class

Represents an observable map of model values. If any items are added, removed, or replaced, then observers that are listening to changes will be notified.

Implemented types
Mixed in types

Constructors

ObservableMap()
Creates an observable map.
ObservableMap.createFromType(Map<K, V> other)
Like ObservableMap.from, but creates an empty map.
factory
ObservableMap.from(Map<K, V> other)
Creates an observable map that contains all key value pairs of other. It will attempt to use the same backing map type if the other map is a LinkedHashMap, SplayTreeMap, or HashMap. Otherwise it defaults to HashMap.
factory
ObservableMap.linked()
Creates a new observable map using a LinkedHashMap.
ObservableMap.sorted()
Creates a new observable map using a SplayTreeMap.
ObservableMap.spy(Map<K, V> other)
Creates a new observable map wrapping other.

Properties

changes → Stream<List<ChangeRecord>>
Emits a list of changes when the state of the object changes.
no setterinherited
entries → Iterable<MapEntry<K, V>>
The map entries of this.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
hasObservers → bool
Whether changes has at least one active listener.
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.
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.
no setteroverride

Methods

addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map.
override
addEntries(Iterable<MapEntry<K, V>> entries) → void
Adds all key/value pairs of newEntries to this map.
override
cast<K2, V2>() → ObservableMap<K2, V2>
Provides a view of this map as having RK keys and RV instances, 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
deliverChanges() → bool
If hasObservers, synchronously emits changes that have been queued.
inherited
forEach(void f(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.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyChange([ChangeRecord? change]) → void
Schedules change to be delivered.
inherited
notifyPropertyChange<T>(Symbol field, T oldValue, T newValue) → T
inherited
observed() → void
May override to be notified when changes is first observed.
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.
override
toString() → String
A string representation of this object.
override
unobserved() → void
May override to be notified when changes is no longer observed.
inherited
update(K key, V update(V value), {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, or null if key is not in the map.
override
operator []=(K key, V value) → void
Associates the key with the given value.
override

Static Methods

castFrom<K, V, K2, V2>(ObservableMap<K, V> source) → ObservableMap<K2, V2>
Adapts source to be a ObservableMap<K2, V2>.
override