PagedList.Config

Added in 2.0.0
Deprecated in 3.0.0

public final class PagedList.Config

Configures how a PagedList loads content from its PagingSource.

Use PagedList.Config.Builder to construct and define custom loading behavior, such as setPageSize, which defines number of items loaded at a time.

Summary

Nested types
public final class PagedList.Config.Builder

This class is deprecated. PagedList is deprecated and has been replaced by PagingData

Public fields
final boolean

This field is deprecated. PagedList is deprecated and has been replaced by PagingData
final int

This field is deprecated. PagedList is deprecated and has been replaced by PagingData
final int

This field is deprecated. PagedList is deprecated and has been replaced by PagingData
final int

This field is deprecated. PagedList is deprecated and has been replaced by PagingData
final int

This field is deprecated. PagedList is deprecated and has been replaced by PagingData

Public fields

enablePlaceholders

Added in 2.0.0
Deprecated in 3.0.0
public final boolean enablePlaceholders

Defines whether the PagedList may display null placeholders, if the PagingSource provides them.

initialLoadSizeHint

Added in 2.0.0
Deprecated in 3.0.0
public final int initialLoadSizeHint

Size hint for initial load of PagedList, often larger than a regular page.

maxSize

Added in 2.1.0
Deprecated in 3.0.0
public final int maxSize

Defines the maximum number of items that may be loaded into this pagedList before pages should be dropped.

If set to PagedList.Config.Companion.MAX_SIZE_UNBOUNDED, pages will never be dropped.

See also
MAX_SIZE_UNBOUNDED
setMaxSize

pageSize

Added in 2.0.0
Deprecated in 3.0.0
public final int pageSize

Size of each page loaded by the PagedList.

prefetchDistance

Added in 2.0.0
Deprecated in 3.0.0
public final int prefetchDistance

Prefetch distance which defines how far ahead to load.

If this value is set to 50, the paged list will attempt to load 50 items in advance of data that's already been accessed.

See also
loadAround