RealmMap

interface RealmMap<K, V> : MutableMap<K, V>

A RealmMap is used to map keys to values. RealmMaps cannot contain duplicate keys and each key can be mapped to at most one value. RealmMaps cannot have null keys but can have null values.

Similarly to RealmList and RealmSet, RealmDictionary properties cannot be nullable.

Most importantly, RealmMaps can only have String keys and should not be used to define properties in RealmObjects. If you need to use a Map<String, V> or a dictionary-type data structure for your model you should use RealmDictionary.

Parameters

the type of the keys stored in this map

the type of the values stored in this map

Functions

asFlow

abstract fun asFlow(): Flow<MapChange<K, V>>

Observes changes to the RealmMap.

clear

abstract fun clear()

containsKey

abstract fun containsKey(key: K): Boolean

containsValue

abstract fun containsValue(value: V): Boolean

get

abstract operator fun get(key: K): V?

isEmpty

abstract fun isEmpty(): Boolean

put

abstract fun put(key: K, value: V): V?

putAll

abstract fun putAll(from: Map<out K, V>)

remove

abstract fun remove(key: K): V?

Properties

entries

abstract override val entries: MutableSet<MutableMap.MutableEntry<K, V>>

keys

abstract override val keys: MutableSet<K>

size

abstract val size: Int

values

abstract override val values: MutableCollection<V>

Inheritors

RealmDictionary