SnapshotStateList

Artifact: androidx.compose.runtime:runtime

Added in 1.0.0

Cmn

class SnapshotStateList<T : Any?> : StateObject, MutableList

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

This class closely implements the same semantics as ArrayList.

See also
`mutableStateListOf`

Summary

Public constructors
`<T : Any?> SnapshotStateList()`	Cmn android

Public functions
`open Boolean`	`add(element: T)`	Cmn android
`open Unit`	`add(index: Int, element: T)`	Cmn android
`open Boolean`	`addAll(elements: Collection<T>)`	Cmn android
`open Boolean`	`addAll(index: Int, elements: Collection<T>)`	Cmn android
`open Unit`	`clear()`	Cmn android
`open operator Boolean`	`contains(element: T)`	Cmn android
`open Boolean`	`containsAll(elements: Collection<T>)`	Cmn android
`open Int`	`describeContents()`	android
`open operator T`	`get(index: Int)`	Cmn android
`open Int`	`indexOf(element: T)`	Cmn android
`open Boolean`	`isEmpty()`	Cmn android
`open operator MutableIterator<T>`	`iterator()`	Cmn android
`open Int`	`lastIndexOf(element: T)`	Cmn android
`open MutableListIterator<T>`	`listIterator()`	Cmn android
`open MutableListIterator<T>`	`listIterator(index: Int)`	Cmn android
`open Unit`	`prependStateRecord(value: StateRecord)` Add a new state record to the beginning of a list.	Cmn android
`open Boolean`	`remove(element: T)`	Cmn android
`open Boolean`	`removeAll(elements: Collection<T>)`	Cmn android
`open T`	`removeAt(index: Int)`	Cmn android
`Unit`	`removeRange(fromIndex: Int, toIndex: Int)`	Cmn android
`open Boolean`	`retainAll(elements: Collection<T>)`	Cmn android
`open operator T`	`set(index: Int, element: T)`	Cmn android
`open MutableList<T>`	`subList(fromIndex: Int, toIndex: Int)`	Cmn android
`List<T>`	`toList()` Return a list containing all the elements of this list.	Cmn android
`open String`	`toString()`	android
`open String`	`toString()`	android
`open Unit`	`writeToParcel(parcel: Parcel, flags: Int)`	android

Public properties
`open StateRecord`	`firstStateRecord` The first state record in a linked list of state records.	Cmn android
`open Int`	`size`	Cmn android

Inherited functions

From kotlin.collections.Collection

`open Stream<T>`	`@RecentlyNonNull parallelStream()`	android
`open Stream<T>`	`@RecentlyNonNull parallelStream()`	android
`open Stream<T>`	`@RecentlyNonNull stream()`	android
`open Stream<T>`	`@RecentlyNonNull stream()`	android
`open Array<T>`	`@RecentlyNonNull <T : Any> toArray(@RecentlyNonNull p0: IntFunction<Array<T>>)` This function is deprecated. This member is not fully supported by Kotlin compiler, so it may be absent or have different signature in next major version	android
`open Array<T>`	`@RecentlyNonNull <T : Any> toArray(@RecentlyNonNull p0: IntFunction<Array<T>>)` This function is deprecated. This member is not fully supported by Kotlin compiler, so it may be absent or have different signature in next major version	android

From kotlin.collections.Iterable

`open Unit`	`forEach(@RecentlyNonNull p0: Consumer<T>)`	android
`open Unit`	`forEach(@RecentlyNonNull p0: Consumer<T>)`	android

From kotlin.collections.List

`open MutableList<T>`	`@RecentlyNonNull reversed()`	android
`open MutableList<T>`	`@RecentlyNonNull reversed()`	android
`open Spliterator<T>`	`@RecentlyNonNull spliterator()`	android
`open Spliterator<T>`	`@RecentlyNonNull spliterator()`	android

From kotlin.collections.MutableCollection

`open Boolean`	`removeIf(@RecentlyNonNull p0: Predicate<T>)`	android
`open Boolean`	`removeIf(@RecentlyNonNull p0: Predicate<T>)`	android

From kotlin.collections.MutableList

`open Unit`	`addFirst(p0: T)`	android
`open Unit`	`addFirst(p0: T)`	android
`open Unit`	`addLast(p0: T)`	android
`open Unit`	`addLast(p0: T)`	android
`open T`	`removeFirst()`	android
`open T`	`removeFirst()`	android
`open T`	`removeLast()`	android
`open T`	`removeLast()`	android
`open Unit`	`replaceAll(@RecentlyNonNull p0: UnaryOperator<T>)`	android
`open Unit`	`replaceAll(@RecentlyNonNull p0: UnaryOperator<T>)`	android
`open Unit`	`sort(@RecentlyNullable p0: Comparator<T>)`	android
`open Unit`	`sort(@RecentlyNullable p0: Comparator<T>)`	android

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.	android
`open StateRecord?`	`mergeRecords( previous: StateRecord, current: StateRecord, applied: StateRecord )` Produce a merged state based on the conflicting state changes.	Cmn
`open StateRecord?`	`mergeRecords( previous: StateRecord, current: StateRecord, applied: StateRecord )` Produce a merged state based on the conflicting state changes.	android

Public constructors

SnapshotStateList

Cmn android

<T : Any?> SnapshotStateList()

Public functions

add

Cmn android

Added in 1.0.0

open fun add(element: T): Boolean

add

Cmn android

Added in 1.0.0

open fun add(index: Int, element: T): Unit

addAll

Cmn android

open fun addAll(elements: Collection<T>): Boolean

addAll

Cmn android

open fun addAll(index: Int, elements: Collection<T>): Boolean

clear

Cmn android

Added in 1.0.0

open fun clear(): Unit

contains

Cmn android

Added in 1.0.0

open operator fun contains(element: T): Boolean

containsAll

Cmn android

open fun containsAll(elements: Collection<T>): Boolean

describeContents

android

Added in 1.9.0-beta01

open fun describeContents(): Int

get

Cmn android

Added in 1.0.0

open operator fun get(index: Int): T

indexOf

Cmn android

Added in 1.0.0

open fun indexOf(element: T): Int

isEmpty

Cmn android

Added in 1.0.0

open fun isEmpty(): Boolean

iterator

Cmn android

Added in 1.0.0

open operator fun iterator(): MutableIterator<T>

lastIndexOf

Cmn android

Added in 1.0.0

open fun lastIndexOf(element: T): Int

listIterator

Cmn android

Added in 1.0.0

open fun listIterator(): MutableListIterator<T>

listIterator

Cmn android

Added in 1.0.0

open fun listIterator(index: Int): MutableListIterator<T>

prependStateRecord

Cmn android

open fun prependStateRecord(value: StateRecord): Unit

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

remove

Cmn android

Added in 1.0.0

open fun remove(element: T): Boolean

removeAll

Cmn android

open fun removeAll(elements: Collection<T>): Boolean

removeAt

Cmn android

Added in 1.0.0

open fun removeAt(index: Int): T

removeRange

Cmn android

Added in 1.0.0

fun removeRange(fromIndex: Int, toIndex: Int): Unit

retainAll

Cmn android

open fun retainAll(elements: Collection<T>): Boolean

set

Cmn android

Added in 1.0.0

open operator fun set(index: Int, element: T): T

subList

Cmn android

Added in 1.0.0

open fun subList(fromIndex: Int, toIndex: Int): MutableList<T>

toList

Cmn android

Added in 1.4.0

fun toList(): List<T>

Return a list containing all the elements of this list.

The list returned is immutable and returned will not change even if the content of the list 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 list as adding and removing the same item from the this list might produce a different instance with the same content.

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

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

toString

android

open fun toString(): String

toString

android

open fun toString(): String

writeToParcel

android

Added in 1.9.0-beta01

open fun writeToParcel(parcel: Parcel, flags: Int): Unit

Public properties

firstStateRecord

Cmn android

open val firstStateRecord: StateRecord

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

size

Cmn android

Added in 1.0.0

open val size: Int