Builder

Kotlin |Java

class Builder<Key : Any, Value : Any>

kotlin.Any
↳	androidx.paging.PagedList.Builder

Builder class for PagedList.

pagingSource, config, notifyDispatcher and fetchDispatcher must all be provided.

A PagedList queries initial data from its PagingSource during construction, to avoid empty PagedLists being presented to the UI when possible. It's preferred to present initial data, so that the UI doesn't show an empty list, or placeholders for a few frames, just before showing initial content.

LivePagedListBuilder does this creation on a background thread automatically, if you want to receive a LiveData<PagedList<...>>.

Summary

Public constructors
<init>(dataSource: DataSource<Key, Value>, config: PagedList.Config) Create a Builder with the provided DataSource and Config.
<init>(dataSource: DataSource<Key, Value>, pageSize: Int) Create a PagedList.Builder with the provided DataSource and pageSize.
<init>(pagingSource: PagingSource<Key, Value>, initialPage: PagingSource.LoadResult.Page<Key, Value>, config: PagedList.Config) Create a PagedList.Builder with the provided PagingSource, initial PagingSource.LoadResult.Page, and PagedList.Config.
<init>(pagingSource: PagingSource<Key, Value>, initialPage: PagingSource.LoadResult.Page<Key, Value>, pageSize: Int) Create a PagedList.Builder with the provided PagingSource, initial PagingSource.LoadResult.Page, and pageSize.

Public methods
PagedList<Value>	build() Creates a PagedList with the given parameters.
PagedList.Builder<Key, Value>	setBoundaryCallback(boundaryCallback: PagedList.BoundaryCallback<Value>?) The BoundaryCallback for out of data events.
PagedList.Builder<Key, Value>	setCoroutineScope(coroutineScope: CoroutineScope) Set the CoroutineScope that page loads should be launched within.
PagedList.Builder<Key, Value>	setFetchDispatcher(fetchDispatcher: CoroutineDispatcher) The CoroutineDispatcher used to fetch additional pages from the PagingSource.
PagedList.Builder<Key, Value>	setFetchExecutor(fetchExecutor: Executor) The Executor used to fetch additional pages from the PagingSource.
PagedList.Builder<Key, Value>	setInitialKey(initialKey: Key?) Sets the initial key the PagingSource should load around as part of initialization.
PagedList.Builder<Key, Value>	setNotifyDispatcher(notifyDispatcher: CoroutineDispatcher) The CoroutineDispatcher defining where page loading updates are dispatched.
PagedList.Builder<Key, Value>	setNotifyExecutor(notifyExecutor: Executor) The Executor defining where page loading updates are dispatched.

Public constructors

<init>

Builder(
    dataSource: DataSource<Key, Value>, 
    config: PagedList.Config)

Create a Builder with the provided DataSource and Config.

Parameters
dataSource: DataSource<Key, Value>	DataSource the PagedList will load from.
config: PagedList.Config	PagedList.Config that defines how the PagedList loads data from its DataSource.

<init>

Builder(
    dataSource: DataSource<Key, Value>, 
    pageSize: Int)

Create a PagedList.Builder with the provided DataSource and pageSize.

This method is a convenience for:

PagedList.Builder(dataSource,
    new PagedList.Config.Builder().setPageSize(pageSize).build());

Parameters
dataSource: DataSource<Key, Value>	DataSource the PagedList will load from.
pageSize: Int	Size of loaded pages when the PagedList loads data from its DataSource.

<init>

Builder(
    pagingSource: PagingSource<Key, Value>, 
    initialPage: PagingSource.LoadResult.Page<Key, Value>, 
    config: PagedList.Config)

Create a PagedList.Builder with the provided PagingSource, initial PagingSource.LoadResult.Page, and PagedList.Config.

Parameters
pagingSource: PagingSource<Key, Value>	PagingSource the PagedList will load from.
initialPage: PagingSource.LoadResult.Page<Key, Value>	Initial page loaded from the PagingSource.
config: PagedList.Config	PagedList.Config that defines how the PagedList loads data from its PagingSource.

<init>

Builder(