RxPagedListKt

public final class RxPagedListKt


Summary

Public methods

static final @NonNull Flowable<@NonNull PagedList<@NonNull Value>>
<Key extends Object, Value extends Object> RxPagedListKt.toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toObservable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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> RxPagedListKt.toObservable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable Scheduler notifyScheduler
)

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

Public methods

RxPagedListKt.toFlowable

@NonNull
public static final Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> RxPagedListKt.toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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.

@Nullable Key initialLoadKey

Initial load key passed to the first PagedList / DataSource.

@Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.

@Nullable Scheduler fetchScheduler

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

@Nullable 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.

RxPagedListKt.toFlowable

@NonNull
public static final Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> RxPagedListKt.toFlowable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    int pageSize,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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.

@Nullable Key initialLoadKey

Initial load key passed to the first PagedList / DataSource.

@Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.

@Nullable Scheduler fetchScheduler

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

@Nullable 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.

RxPagedListKt.toFlowable

@NonNull
public static final Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> RxPagedListKt.toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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.

@Nullable Key initialLoadKey

Initial load key passed to the first PagedList / PagingSource.

@Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.

@Nullable Scheduler fetchScheduler

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

@Nullable 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.

RxPagedListKt.toFlowable

@NonNull
public static final Flowable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> RxPagedListKt.toFlowable(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> receiver,
    int pageSize,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback,
    @Nullable Scheduler fetchScheduler,
    @Nullable 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.

@Nullable Key initialLoadKey

Initial load key passed to the first PagedList / PagingSource.

@Nullable PagedList.BoundaryCallback<@NonNull Value> boundaryCallback

The boundary callback for listening to PagedList load state.

@Nullable Scheduler fetchScheduler

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

@Nullable 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.

RxPagedListKt.toObservable

@NonNull
public static final Observable<@NonNull PagedList<@NonNull Value>> <Key extends Object, Value extends Object> RxPagedListKt.toObservable(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> receiver,
    @NonNull PagedList.Config config,
    @Nullable Key initialLoadKey,
    @Nullable PagedList.BoundaryCallback<@