SnapshotStateList

Artifact: androidx.compose.runtime:runtime

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• 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

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

Public properties
open StateRecord	firstStateRecord The first state record in a linked list of state records.	Cmn
open Int	size	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

SnapshotStateList

Cmn

<T : Any?> SnapshotStateList()

Public functions

add

Cmn

Added in 1.0.0

open fun add(element: T): Boolean

add

Cmn

Added in 1.0.0

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

addAll

Cmn

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

addAll

Cmn

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

clear

Cmn

Added in 1.0.0

open fun clear(): Unit

contains

Cmn

Added in 1.0.0

open operator fun contains(element: T): Boolean

containsAll

Cmn

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

get

Cmn

Added in 1.0.0

open operator fun get(index: Int): T

indexOf

Cmn

Added in 1.0.0

open fun indexOf(element: T): Int

isEmpty

Cmn

Added in 1.0.0

open fun isEmpty(): Boolean

iterator

Cmn

Added in 1.0.0

open operator fun iterator(): MutableIterator<T>

lastIndexOf

Cmn

Added in 1.0.0

open fun lastIndexOf(element: T): Int

listIterator

Cmn

Added in 1.0.0

open fun listIterator(): MutableListIterator<T>

listIterator

Cmn

Added in 1.0.0

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

prependStateRecord

Cmn

Added in 1.8.0-alpha06

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

Added in 1.0.0

open fun remove(element: T): Boolean

removeAll

Cmn

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

removeAt

Cmn

Added in 1.0.0

open fun removeAt(index: Int): T

removeRange

Cmn

Added in 1.0.0

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

retainAll

Cmn

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

set

Cmn

Added in 1.0.0

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

subList

Cmn

Added in 1.0.0

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

toList

Cmn

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

Cmn

open fun toString(): String

Public properties

firstStateRecord

Cmn

Added in 1.8.0-alpha06

open val firstStateRecord: StateRecord

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

size

Cmn

Added in 1.0.0

open val size: Int