ItemSnapshotList

Added in 3.0.0

Kotlin |Java

Cmn

class ItemSnapshotList<T : Any?> : AbstractList

kotlin.Any
↳	kotlin.collections.AbstractCollection
	↳	kotlin.collections.AbstractList
		↳	androidx.paging.ItemSnapshotList

Snapshot of data being presented by a androidx.pagingAsyncPagingDataDiffer or a androidx.paging.PagingDataAdapter.

Summary

Public constructors
`<T : Any?> ItemSnapshotList( placeholdersBefore: @IntRange(from = 0) Int, placeholdersAfter: @IntRange(from = 0) Int, items: List<T> )`	Cmn

Public functions
`open operator T?`	`get(index: Int)` Returns the item at `index`, where `index` includes the position of placeholders.	Cmn

Public properties
`List<T>`	`items` The presented data, excluding placeholders.	Cmn
`Int`	`placeholdersAfter` Number of placeholders after the presented `items`, 0 if `enablePlaceholders` is `false`.	Cmn
`Int`	`placeholdersBefore` Number of placeholders before the presented `items`, 0 if `enablePlaceholders` is `false`.	Cmn
`open Int`	`size` Size of `ItemSnapshotList` including placeholders.	Cmn

Inherited functions

From kotlin.collections.AbstractCollection

`open operator Boolean`	`contains(element: T?)`	Cmn
`open Boolean`	`containsAll(elements: Collection<T?>)`	Cmn
`open Boolean`	`isEmpty()`	Cmn
`open Array<Any?>`	`toArray()`	Cmn
`open Array<T>`	`<T : Any?> toArray(array: Array<T>)`	Cmn
`open String`	`toString()`	Cmn

From kotlin.collections.AbstractList

`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open Int`	`indexOf(element: T?)`	Cmn
`open operator Iterator<T?>`	`iterator()`	Cmn
`open Int`	`lastIndexOf(element: T?)`	Cmn
`open ListIterator<T?>`	`listIterator()`	Cmn
`open ListIterator<T?>`	`listIterator(index: Int)`	Cmn
`open List<T?>`	`subList(fromIndex: Int, toIndex: Int)`	Cmn

Public constructors

ItemSnapshotList

Cmn

<T : Any?> ItemSnapshotList(
    placeholdersBefore: @IntRange(from = 0) Int,
    placeholdersAfter: @IntRange(from = 0) Int,
    items: List<T>
)

Public functions

get

Cmn

Added in 3.0.0

open operator fun get(index: Int): T?

Returns the item at index, where index includes the position of placeholders. If index points to the position of a placeholder, null is returned.

To get the size using an index excluding placeholders, use List.size on items directly.

Throws
`kotlin.IndexOutOfBoundsException`	if `index`< 0 or `index` `size`.

Public properties

items

Cmn

Added in 3.0.0

val items: List<T>

The presented data, excluding placeholders.

placeholdersAfter

Cmn

Added in 3.0.0

val placeholdersAfter: Int

Number of placeholders after the presented items, 0 if enablePlaceholders is false.

placeholdersBefore

Cmn

Added in 3.0.0

val placeholdersBefore: Int

Number of placeholders before the presented items, 0 if enablePlaceholders is false.

size

Cmn

Added in 3.0.0

open val size: Int

Size of ItemSnapshotList including placeholders.

To get the size excluding placeholders, use List.size on items directly.

See also
`items`