ItemSnapshotList

Added in 3.0.0

Kotlin |Java

public final class ItemSnapshotList<T extends Object> extends AbstractList

java.lang.Object
↳	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 extends Object> ItemSnapshotList( @IntRange(from = 0) int placeholdersBefore, @IntRange(from = 0) int placeholdersAfter, @NonNull List<@NonNull T> items )`

Public methods
`T`	`get(int index)` Returns the item at `index`, where `index` includes the position of placeholders.
`final @NonNull List<@NonNull T>`	`getItems()` The presented data, excluding placeholders.
`final int`	`getPlaceholdersAfter()` Number of placeholders after the presented `items`, 0 if `enablePlaceholders` is `false`.
`final int`	`getPlaceholdersBefore()` Number of placeholders before the presented `items`, 0 if `enablePlaceholders` is `false`.
`int`	`getSize()` Size of `ItemSnapshotList` including placeholders.

Inherited methods

From kotlin.collections.AbstractCollection

`boolean`	`contains(T element)`
`boolean`	`containsAll(@NonNull Collection<T> elements)`
`boolean`	`isEmpty()`
`@NonNull Object[]`	`toArray()`
`@NonNull T[]`	`<T extends Object> toArray(@NonNull T[] array)`
`@NonNull String`	`toString()`

From kotlin.collections.AbstractList

`boolean`	`equals(Object other)`
`int`	`hashCode()`
`int`	`indexOf(T element)`
`@NonNull Iterator<T>`	`iterator()`
`int`	`lastIndexOf(T element)`
`@NonNull ListIterator<T>`	`listIterator()`
`@NonNull ListIterator<T>`	`listIterator(int index)`
`@NonNull List<T>`	`subList(int fromIndex, int toIndex)`

Public constructors

ItemSnapshotList

public <T extends Object> ItemSnapshotList(
    @IntRange(from = 0) int placeholdersBefore,
    @IntRange(from = 0) int placeholdersAfter,
    @NonNull List<@NonNull T> items
)

Public methods

get

Added in 3.0.0

public T get(int index)

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
`IndexOutOfBoundsException`	if `index`< 0 or `index`>`size`.

getItems

Added in 3.0.0

public final @NonNull List<@NonNull T> getItems()

The presented data, excluding placeholders.

getPlaceholdersAfter

Added in 3.0.0

public final int getPlaceholdersAfter()

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

getPlaceholdersBefore

Added in 3.0.0

public final int getPlaceholdersBefore()

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

getSize

Added in 3.0.0

public int getSize()

Size of ItemSnapshotList including placeholders.

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

See also
`items`