AsyncListUtil.DataCallback

public abstract class AsyncListUtil.DataCallback<T>


The callback that provides data access for AsyncListUtil.

All methods are called on the background thread.

Summary

Public constructors

Public methods

abstract void
@WorkerThread
fillData(@NonNull T[] data, int startPosition, int itemCount)

Fill the given tile.

int

Returns tile cache size limit (in tiles).

void
@WorkerThread
recycleData(@NonNull T[] data, int itemCount)

Recycle the objects created in fillData if necessary.

abstract int

Refresh the data set and return the new data item count.

Public constructors

DataCallback

Added in 1.0.0
public DataCallback()

Public methods

fillData

Added in 1.0.0
@WorkerThread
public abstract void fillData(@NonNull T[] data, int startPosition, int itemCount)

Fill the given tile.

The provided tile might be a recycled tile, in which case it will already have objects. It is suggested to re-use these objects if possible in your use case.

Parameters
@NonNull T[] data

The data item array to fill into. Should not be accessed beyond itemCount.

int startPosition

The start position in the list.

int itemCount

The data item count.

getMaxCachedTiles

Added in 1.0.0
@WorkerThread
public int getMaxCachedTiles()

Returns tile cache size limit (in tiles).

The actual number of cached tiles will be the maximum of this value and the number of tiles that is required to cover the range returned by extendRangeInto.

For example, if this method returns 10, and the most recent call to extendRangeInto returned {100, 179}, and the tile size is 5, then the maximum number of cached tiles will be 16.

However, if the tile size is 20, then the maximum number of cached tiles will be 10.

The default implementation returns 10.

Returns
int

Maximum cache size.

recycleData

Added in 1.0.0
@WorkerThread
public void recycleData(@NonNull T[] data, int itemCount)

Recycle the objects created in fillData if necessary.

Parameters
@NonNull T[] data

Array of data items. Should not be accessed beyond itemCount.

int itemCount

The data item count.

refreshData

Added in 1.0.0
@WorkerThread
public abstract int refreshData()

Refresh the data set and return the new data item count.

If the data is being accessed through android.database.Cursor this is where the new cursor should be created.

Returns
int

Data item count.