SnapshotStateMap

Artifact: androidx.compose.runtime:runtime

View Source

Added in 1.0.0

Common/All

• Cmn

  class SnapshotStateMap<K : Any?, V : Any?> : StateObject, MutableMap

---

An implementation of MutableMap that can be observed and snapshot. This is the result type created by androidx.compose.runtime.mutableStateMapOf.

This class closely implements the same semantics as HashMap.

See also
mutableStateMapOf

Summary

Public constructors
<K : Any?, V : Any?> SnapshotStateMap()	Cmn

Public functions
open Unit	clear()	Cmn
open Boolean	containsKey(key: K)	Cmn
open Boolean	containsValue(value: V)	Cmn
open operator V?	get(key: K)	Cmn
open Boolean	isEmpty()	Cmn
open Unit	prependStateRecord(value: StateRecord) Add a new state record to the beginning of a list.	Cmn
open V?	put(key: K, value: V)	Cmn
open Unit	putAll(from: Map<K, V>)	Cmn
open V?	remove(key: K)	Cmn
Map<K, V>	toMap() Returns an immutable map containing all key-value pairs from the original map.	Cmn
open String	toString()	Cmn

Public properties
open MutableSet<MutableMap.MutableEntry<K, V>>	entries	Cmn
open StateRecord	firstStateRecord The first state record in a linked list of state records.	Cmn
open MutableSet<K>	keys	Cmn
open Int	size	Cmn
open MutableCollection<V>	values	Cmn

Inherited functions
From androidx.compose.runtime.snapshots.StateObject open StateRecord? mergeRecords(     previous: StateRecord,     current: StateRecord,     applied: StateRecord ) Produce a merged state based on the conflicting state changes. Cmn

Public constructors

SnapshotStateMap

Cmn

<K : Any?, V : Any?> SnapshotStateMap()

Public functions

clear

Cmn

Added in 1.0.0

open fun clear(): Unit

containsKey

Cmn

Added in 1.0.0

open fun containsKey(key: K): Boolean

containsValue

Cmn

Added in 1.0.0

open fun containsValue(value: V): Boolean

get

Cmn

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

isEmpty

Cmn

Added in 1.0.0

open fun isEmpty(): Boolean

prependStateRecord

Cmn

Added in 1.8.0-alpha05

open fun prependStateRecord(value: StateRecord): Unit

Add a new state record to the beginning of a list. After this call firstStateRecord should be value.

put

Cmn

Added in 1.0.0

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

putAll

Cmn

open fun putAll(from: Map<K, V>): Unit

remove

Cmn

open fun remove(key: K): V?

toMap

Cmn

Added in 1.4.0

fun toMap(): Map<K, V>

Returns an immutable map containing all key-value pairs from the original map.

The content of the map returned will not change even if the content of the map is changed in the same snapshot. It also will be the same instance until the content is changed. It is not, however, guaranteed to be the same instance for the same content as adding and removing the same item from the this map might produce a different instance with the same content.

This operation is O(1) and does not involve a physically copying the map. It instead returns the underlying immutable map used internally to store the content of the map.

It is recommended to use toMap when using returning the value of this map from androidx.compose.runtime.snapshotFlow.

toString

Cmn

open fun toString(): String

Public properties

entries

Cmn

Added in 1.0.0

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

firstStateRecord

Cmn

Added in 1.8.0-alpha05

open val firstStateRecord: StateRecord

The first state record in a linked list of state records.

keys

Cmn

Added in 1.0.0

open val keys: MutableSet<K>

size

Cmn

Added in 1.0.0

open val size: Int

values

Cmn

Added in 1.0.0

open val values: MutableCollection<V>