RxPagedListBuilder
classRxPagedListBuilder<Key : Any, Value : Any>
kotlin.Any | |
↳ | androidx.paging.RxPagedListBuilder |
Builder for Observable<PagedList>
or Flowable<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).
The returned observable/flowable will already be subscribed on the setFetchScheduler, and will perform all loading on that scheduler. It will already be observed on setNotifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.
Summary
Public constructors | |
---|---|
<init>(pagingSourceFactory: () -> PagingSource<Key, Value>, config: PagedList.Config) Creates a RxPagedListBuilder with required parameters. |
|
<init>(pagingSourceFactory: () -> PagingSource<Key, Value>, pageSize: Int) Creates a RxPagedListBuilder with required parameters. |
|
<init>(dataSourceFactory: DataSource.Factory<Key, Value>, config: PagedList.Config) Creates a RxPagedListBuilder with required parameters. |
|
<init>(dataSourceFactory: DataSource.Factory<Key, Value>, pageSize: Int) Creates a RxPagedListBuilder with required parameters. |
Public methods | |
---|---|
Flowable<PagedList<Value>> |
buildFlowable(backpressureStrategy: BackpressureStrategy) Constructs a |
Observable<PagedList<Value>> |
Constructs a |
RxPagedListBuilder<Key, Value> |
setBoundaryCallback(boundaryCallback: PagedList.BoundaryCallback<Value>?) Sets a androidx.paging.PagedList.BoundaryCallback on each PagedList created, typically used to load additional data from network when paging from local storage. |
RxPagedListBuilder<Key, Value> |
setFetchScheduler(scheduler: Scheduler) Sets scheduler which will be used for background fetching of PagedLists, as well as on-demand fetching of pages inside. |
RxPagedListBuilder<Key, Value> |
setInitialLoadKey(key: Key?) First loading key passed to the first PagedList/DataSource. |
RxPagedListBuilder<Key, Value> |
setNotifyScheduler(scheduler: Scheduler) Sets scheduler which will be used for observing new PagedLists, as well as loading updates within the PagedLists. |
Public constructors
<init>
RxPagedListBuilder(
pagingSourceFactory: () -> PagingSource<Key, Value>,
config: PagedList.Config)
Creates a RxPagedListBuilder with required parameters.
Parameters | |
---|---|
pagingSourceFactory: () -> PagingSource<Key, Value> | DataSource factory providing DataSource generations. |
config: PagedList.Config | Paging configuration. |
<init>
RxPagedListBuilder(
pagingSourceFactory: () -> PagingSource<Key, Value>,
pageSize: Int)
Creates a RxPagedListBuilder with required parameters.
This method is a convenience for:
RxPagedListBuilder( pagingSourceFactory, PagedList.Config.Builder().setPageSize(pageSize).build() )
Parameters | |
---|---|
pagingSourceFactory: () -> PagingSource<Key, Value> | PagingSource factory providing PagingSource generations. |
pageSize: Int | Size of pages to load. |
<init>
RxPagedListBuilder(
dataSourceFactory: DataSource.Factory<Key, Value>,
config: PagedList.Config)
Creates a RxPagedListBuilder with required parameters.
Parameters | |
---|---|
dataSourceFactory: DataSource.Factory<Key, Value> | DataSource factory providing DataSource generations. |
config: PagedList.Config | Paging configuration. |
<init>
RxPagedListBuilder(
dataSourceFactory: DataSource.Factory<Key, Value>,
pageSize: Int)
Creates a RxPagedListBuilder with required parameters.
This method is a convenience for:
RxPagedListBuilder( dataSourceFactory, PagedList.Config.Builder().setPageSize(pageSize).build() )
Parameters | |
---|---|
dataSourceFactory: DataSource.Factory<Key, Value> | DataSource.Factory providing DataSource generations. |
pageSize: Int | Size of pages to load. |
Public methods
buildFlowable
fun buildFlowable(backpressureStrategy: BackpressureStrategy): Flowable<PagedList<Value>>
Constructs a Flowable<PagedList>
.
The returned Observable will already be observed on the notifyScheduler, and subscribed on the fetchScheduler.
Parameters | |
---|---|
backpressureStrategy: BackpressureStrategy | BackpressureStrategy for the Flowable to use. |
Return | |
---|---|
The | Flowable of PagedLists |
buildObservable
fun buildObservable(): Observable<PagedList<Value>>
Constructs a Observable<PagedList>
.
The returned Observable will already be observed on the notifyScheduler, and subscribed on the fetchScheduler.
Return | |
---|---|
The | Observable of PagedLists |
setBoundaryCallback
fun setBoundaryCallback(boundaryCallback: PagedList.BoundaryCallback<Value>?): RxPagedListBuilder<Key, Value>
Sets a androidx.paging.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 Observable<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 | |
---|---|
this |
setFetchScheduler
fun setFetchScheduler(scheduler: Scheduler): RxPagedListBuilder<Key, Value>
Sets scheduler which will be used for background fetching of PagedLists, as well as on-demand fetching of pages inside.
If not set, defaults to the Arch components I/O thread pool.
The built Observable / Flowable will be subscribed on this scheduler.
Parameters | |
---|---|
scheduler: Scheduler | Scheduler used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading. |
Return | |
---|---|
this |
setInitialLoadKey
fun setInitialLoadKey(key: Key?): RxPagedListBuilder<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 | |
---|---|
this |
setNotifyScheduler
fun setNotifyScheduler(scheduler: Scheduler): RxPagedListBuilder<Key, Value>
Sets scheduler which will be used for observing new PagedLists, as well as loading updates within the PagedLists.
If not set, defaults to the UI thread.
The built Observable / Flowable will be observed on this scheduler, so that the thread receiving PagedLists will also receive the internal updates to the PagedList.
Parameters | |
---|---|
scheduler: Scheduler | Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI/main thread. |
Return | |
---|---|
this |