Android Dev Summit, October 23-24: two days of technical content, directly from the Android team. Sign-up for livestream updates.

LivePagedListBuilder

class LivePagedListBuilder<Key : Any!, Value : Any!>
kotlin.Any
   ↳ androidx.paging.LivePagedListBuilder

Builder for LiveData<PagedList>, given a DataSource.Factory and a PagedList.Config.

The required parameters are in the constructor, so you can simply construct and build, or optionally enable extra features (such as initial load key, or BoundaryCallback).

Summary

Public constructors

<init>(@NonNull dataSourceFactory: DataSource.Factory<Key, Value>, @NonNull config: PagedList.Config)

Creates a LivePagedListBuilder with required parameters.

<init>(@NonNull dataSourceFactory: DataSource.Factory<Key, Value>, pageSize: Int)

Creates a LivePagedListBuilder with required parameters.

Public methods

LiveData<PagedList<Value>!>

Constructs the LiveData<PagedList>.

LivePagedListBuilder<Key, Value>
setBoundaryCallback(@Nullable boundaryCallback: PagedList.BoundaryCallback<Value>?)

Sets a PagedList.BoundaryCallback on each PagedList created, typically used to load additional data from network when paging from local storage.

LivePagedListBuilder<Key, Value>
setFetchExecutor(@NonNull fetchExecutor: Executor)

Sets executor used for background fetching of PagedLists, and the pages within.

LivePagedListBuilder<Key, Value>
setInitialLoadKey(@Nullable key: Key?)

First loading key passed to the first PagedList/DataSource.

Public constructors

<init>

LivePagedListBuilder(@NonNull dataSourceFactory: DataSource.Factory<Key, Value>, @NonNull config: PagedList.Config)

Creates a LivePagedListBuilder with required parameters.

Parameters
dataSourceFactory DataSource.Factory<Key, Value>: DataSource factory providing DataSource generations.
config DataSource.Factory<Key, Value>: Paging configuration.

<init>

LivePagedListBuilder(@NonNull dataSourceFactory: DataSource.Factory<Key, Value>, pageSize: Int)

Creates a LivePagedListBuilder with required parameters.

This method is a convenience for:

LivePagedListBuilder(dataSourceFactory,
              new PagedList.Config.Builder().setPageSize(pageSize).build())
      
Parameters
dataSourceFactory DataSource.Factory<Key, Value>: DataSource.Factory providing DataSource generations.
pageSize DataSource.Factory<Key, Value>: Size of pages to load.

Public methods

build

@NonNull fun build(): LiveData<PagedList<Value>!>

Constructs the LiveData<PagedList>.

No work (such as loading) is done immediately, the creation of the first PagedList is is deferred until the LiveData is observed.

Return
LiveData<PagedList<Value>!>: The LiveData of PagedLists

setBoundaryCallback

@NonNull fun setBoundaryCallback(@Nullable boundaryCallback: PagedList.BoundaryCallback<Value>?): LivePagedListBuilder<Key, Value>

Sets a PagedList.BoundaryCallback on each PagedList created, typically used to load additional data from network when paging from local storage.

Pass a BoundaryCallback to listen to when the PagedList runs out of data to load. If this method is not called, or null is passed, you will not be notified when each DataSource runs out of data to provide to its PagedList.

If you are paging from a DataSource.Factory backed by local storage, you can set a BoundaryCallback to know when there is no more information to page from local storage. This is useful to page from the network when local storage is a cache of network data.

Note that when using a BoundaryCallback with a LiveData<PagedList>, method calls on the callback may be dispatched multiple times - one for each PagedList/DataSource pair. If loading network data from a BoundaryCallback, you should prevent multiple dispatches of the same method from triggering multiple simultaneous network loads.

Parameters
boundaryCallback PagedList.BoundaryCallback<Value>?: The boundary callback for listening to PagedList load state.
Return
LivePagedListBuilder<Key, Value>: this

setFetchExecutor

@NonNull fun setFetchExecutor(@NonNull fetchExecutor: Executor): LivePagedListBuilder<Key, Value>

Sets executor used for background fetching of PagedLists, and the pages within.

If not set, defaults to the Arch components I/O thread pool.

Parameters
fetchExecutor Executor: Executor for fetching data from DataSources.
Return
LivePagedListBuilder<Key, Value>: this

setInitialLoadKey

@NonNull fun setInitialLoadKey(@Nullable key: Key?): LivePagedListBuilder<Key, Value>

First loading key passed to the first PagedList/DataSource.

When a new PagedList/DataSource pair is created after the first, it acquires a load key from the previous generation so that data is loaded around the position already being observed.

Parameters
key Key?: Initial load key passed to the first PagedList/DataSource.
Return
LivePagedListBuilder<Key, Value>: this