RealmMap<T extends Object?> class abstract

RealmMap is a collection that contains key-value pairs of <String, T>.

Implemented types
Mixed-in types
Available extensions

Constructors

RealmMap(Map<String, T> items)
Creates an unmanaged RealmMap from items
factory

Properties

changes → Stream<RealmMapChanges<T>>
Allows listening for changes when the contents of this collection changes.
no setter
entries → Iterable<MapEntry<String, T>>
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
isFrozen → bool
True if the entity belongs to a frozen Realm.
no setterinherited
isManaged → bool
True if the object belongs to a Realm.
no setterinherited
isNotEmpty → bool
Whether there is at least one key/value pair in the map.
no setterinherited
isValid → bool
Gets a value indicating whether this collection is still valid to use.
no setter
keys → Iterable<String>
The keys of this Map.
no setterinherited
length → int
The number of key/value pairs in the map.
no setterinherited
realm → Realm
The Realm instance this object belongs to.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
values → Iterable<T>
The values of this Map.
no setterinherited

Methods

addAll(Map<String, T> other) → void
Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry<String, T>> 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
changesFor([List<String>? keyPaths]) → Stream<RealmMapChanges<T?>>

Available on RealmMap<T?>, provided by the RealmMapOfObject extension

Allows listening for changes when the contents of this collection changes on one of the provided keyPaths. If keyPaths is null, default notifications will be raised (same as RealmMap.change). If keyPaths is an empty list, only notifications related to the collection itself will be raised (such as adding or removing elements).
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 action(String key, T value)) → void
Applies action to each key/value pair of the map.
inherited
freeze() → RealmMap<T>
Creates a frozen snapshot of this RealmMap.
map<K2, V2>(MapEntry<K2, V2> transform(String key, T value)) → 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 nonexistent method or property is accessed.
inherited
putIfAbsent(String key, T ifAbsent()) → T
Look up the value of key, or add a new entry if it isn't there.
inherited
query(String query, [List<Object?> arguments = const []]) → RealmResults<T>

Available on RealmMap<T?>, provided by the RealmMapOfObject extension

Filters the map values and returns a new RealmResults according to the provided query (with optional arguments).
remove(Object? key) → T?
Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool test(String key, T value)) → void
Removes all entries of this map that satisfy the given test.
inherited
toString() → String
A string representation of this object.
inherited
update(String key, T update(T value), {T ifAbsent()?}) → T
Updates the value for the provided key.
inherited
updateAll(T update(String key, T value)) → void
Updates all values.
inherited

Operators

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