RxPagedListKt

Added in 3.1.0

public final class RxPagedListKt

Summary

Public methods
static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Observable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Observable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Observable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toObservable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

This method is deprecated. PagedList is deprecated and has been replaced by PagingData
static final @NonNull Observable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> toObservable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

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

Public methods

toFlowable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

Constructs a Flowable<PagedList>, from this DataSource.Factory, convenience for RxPagedListBuilder.

The returned Flowable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
@NonNull PagedList.Config config

Paging configuration.
Key initialLoadKey

Initial load key passed to the first PagedList / DataSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
@NonNull BackpressureStrategy backpressureStrategy

BackpressureStrategy for the Flowable to use.
See also
RxPagedListBuilder
toObservable

toFlowable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

Constructs a Flowable<PagedList>, from this DataSource.Factory, convenience for RxPagedListBuilder.

The returned Flowable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
int pageSize

Page size.
Key initialLoadKey

Initial load key passed to the first PagedList / DataSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
@NonNull BackpressureStrategy backpressureStrategy

BackpressureStrategy for the Flowable to use.
See also
RxPagedListBuilder
toObservable

toFlowable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

Constructs a Flowable<PagedList>, from this PagingSource factory, convenience for RxPagedListBuilder.

The returned Flowable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
@NonNull PagedList.Config config

Paging configuration.
Key initialLoadKey

Initial load key passed to the first PagedList / PagingSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from PagingSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
@NonNull BackpressureStrategy backpressureStrategy

BackpressureStrategy for the Flowable to use.
See also
RxPagedListBuilder
toObservable

toFlowable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler,
    @NonNull BackpressureStrategy backpressureStrategy
)

Constructs a Flowable<PagedList>, from this PagingSource factory, convenience for RxPagedListBuilder.

The returned Flowable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
int pageSize

Page size.
Key initialLoadKey

Initial load key passed to the first PagedList / PagingSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from PagingSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
@NonNull BackpressureStrategy backpressureStrategy

BackpressureStrategy for the Flowable to use.
See also
RxPagedListBuilder
toObservable

toObservable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Observable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

Constructs a Observable<PagedList> from this DataSource.Factory, convenience for RxPagedListBuilder.

The returned Observable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
@NonNull PagedList.Config config

Paging configuration.
Key initialLoadKey

Initial load key passed to the first PagedList / DataSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
See also
RxPagedListBuilder
toFlowable

toObservable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Observable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

Constructs a Observable<PagedList> from this DataSource.Factory, convenience for RxPagedListBuilder.

The returned Observable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
int pageSize

Size of pages to load.
Key initialLoadKey

Initial load key passed to the first PagedList / DataSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
See also
RxPagedListBuilder
toFlowable

toObservable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Observable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toObservable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

Constructs a Observable<PagedList> from this PagingSource factory, convenience for RxPagedListBuilder.

The returned Observable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
@NonNull PagedList.Config config

Paging configuration.
Key initialLoadKey

Initial load key passed to the first PagedList / PagingSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from PagingSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
See also
RxPagedListBuilder
toFlowable

toObservable

Added in 3.1.0
Deprecated in 3.1.0
public static final @NonNull Observable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> toObservable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    Key initialLoadKey,
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    Scheduler fetchScheduler,
    Scheduler notifyScheduler
)

Constructs a Observable<PagedList> from this PagingSource factory, convenience for RxPagedListBuilder.

The returned Observable will already be subscribed on the fetchScheduler, and will perform all loading on that scheduler. It will already be observed on notifyScheduler, and will dispatch new PagedLists, as well as their updates to that scheduler.

Parameters
int pageSize

Size of pages to load.
Key initialLoadKey

Initial load key passed to the first PagedList / PagingSource.
PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.
Scheduler fetchScheduler

Scheduler used to fetch from PagingSources, generally a background thread pool for e.g. I/O or network loading.
Scheduler notifyScheduler

Scheduler that receives PagedList updates, and where PagedList.Callback calls are dispatched. Generally, this is the UI / main thread.
See also
RxPagedListBuilder
toFlowable