{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}
open class AsyncPagedListDiffer<T : Any>
Helper object for mapping a androidx.paging.PagedList
into a androidx.recyclerview.widget.RecyclerView.Adapter.
For simplicity, the PagedListAdapter
wrapper class can often be used instead of the differ directly. This diff class is exposed for complex cases, and where overriding an adapter base class to support paging isn't convenient.
When consuming a LiveData of PagedList, you can observe updates and dispatch them directly to submitList
. The AsyncPagedListDiffer then can present this updating data set simply for an adapter. It listens to PagedList loading callbacks, and uses DiffUtil on a background thread to compute updates as new PagedLists are received.
It provides a simple list-like API with getItem
and itemCount
for an adapter to acquire and present data objects.
A complete usage pattern with Room would look like this:
@Dao
interface UserDao {
@Query("SELECT * FROM user ORDER BY lastName ASC")
public abstract DataSource.Factory<Integer, User> usersByLastName();
}
class MyViewModel extends ViewModel {
public final LiveData<PagedList<User>> usersList;
public MyViewModel(UserDao userDao) {
usersList = new LivePagedListBuilder<>(
userDao.usersByLastName(), /* page size */20).build();
}
}
class MyActivity extends AppCompatActivity {
@Override
public void onCreate(Bundle savedState) {
super.onCreate(savedState);
MyViewModel viewModel = new ViewModelProvider(this).get(MyViewModel.class);
RecyclerView recyclerView = findViewById(R.id.user_list);
final UserAdapter adapter = new UserAdapter();
viewModel.usersList.observe(this, pagedList -> adapter.submitList(pagedList));
recyclerView.setAdapter(adapter);
}
}
class UserAdapter extends RecyclerView.Adapter<UserViewHolder> {
private final AsyncPagedListDiffer<User> differ =
new AsyncPagedListDiffer(this, DIFF_CALLBACK);
@Override
public int getItemCount() {
return differ.getItemCount();
}
public void submitList(PagedList<User> pagedList) {
differ.submitList(pagedList);
}
@Override
public void onBindViewHolder(UserViewHolder holder, int position) {
User user = differ.getItem(position);
if (user != null) {
holder.bindTo(user);
} else {
// Null defines a placeholder item - AsyncPagedListDiffer will automatically
// invalidate this row when the actual object is loaded from the database
holder.clear();
}
}
public static final DiffUtil.ItemCallback<User> DIFF_CALLBACK =
new DiffUtil.ItemCallback<User>() {
@Override
public boolean areItemsTheSame(
@NonNull User oldUser, @NonNull User newUser) {
// User properties may have changed if reloaded from the DB, but ID is fixed
return oldUser.getId() == newUser.getId();
}
@Override
public boolean areContentsTheSame(@NonNull User oldUser, @NonNull User newUser) {
// NOTE: if you use equals, your object must properly override Object#equals()
// Incorrectly returning false here will result in too many animations.
return oldUser.equals(newUser);
}
}
}
Parameters | |
---|---|
<T : Any> |
Type of the PagedLists this differ will receive. |
Nested types |
|
---|---|
AsyncPagedListDiffer.PagedListListener |
Listener for when the current |
Public properties |
|
---|---|
open PagedList<T>? |
Returns the PagedList currently being displayed by the differ. |
open Int |
Get the number of items currently presented by this Differ. |
Public constructors |
|
---|---|
<T : Any> Convenience for |
|
<T : Any> |
Public functions |
|
---|---|
open Unit |
addLoadStateListener(listener: (LoadType, LoadState) -> Unit) Add a |
open Unit |
addPagedListListener( Add a |
Unit |
addPagedListListener(callback: (PagedList<T>?, PagedList<T>?) -> Unit) Add a callback to receive updates when the current |
open T? |
Get the item from the current PagedList at the specified index. |
open Unit |
removeLoadStateListener(listener: (LoadType, LoadState) -> Unit) Remove a previously registered |
open Unit |
removePagedListListener( Remove a previously registered |
Unit |
removePagedListListener(callback: (PagedList<T>?, PagedList<T>?) -> Unit) Remove a previously registered callback via |
open Unit |
submitList(pagedList: PagedList<T>?) Pass a new |
open Unit |
submitList(pagedList: PagedList<T>?, commitCallback: Runnable?) Pass a new PagedList to the differ. |
open val currentList: PagedList<T>?
Returns the PagedList currently being displayed by the differ.
This is not necessarily the most recent list passed to submitList
, because a diff is computed asynchronously between the new list and the current list before updating the currentList value. May be null
if no PagedList
is being presented.
Returns | |
---|---|
PagedList<T>? |
The list currently being displayed, may be |
open val itemCount: Int
Get the number of items currently presented by this Differ. This value can be directly returned to RecyclerView.Adapter.getItemCount.
Returns | |
---|---|
Int |
Number of items being presented. |
<T : Any>AsyncPagedListDiffer(
adapter: <ERROR CLASS><<ERROR CLASS>>,
diffCallback: <ERROR CLASS><T>
)
Convenience for
AsyncPagedListDiffer(
AdapterListUpdateCallback(adapter),
AsyncDifferConfig.Builder<T>(diffCallback).build()
)
Parameters | |
---|---|
adapter: <ERROR CLASS><<ERROR CLASS>> |
Adapter that will receive update signals. |
diffCallback: <ERROR CLASS><T> |
The DiffUtil.ItemCallback instance to compare items in the list. |
<T : Any>AsyncPagedListDiffer(
listUpdateCallback: <ERROR CLASS>,
config: <ERROR CLASS><T>
)
open fun addLoadStateListener(listener: (LoadType, LoadState) -> Unit): Unit
Add a LoadState
listener to observe the loading state of the current PagedList
.
As new PagedLists are submitted and displayed, the listener will be notified to reflect current LoadType.REFRESH
, LoadType.PREPEND
, and LoadType.APPEND
states.
See also | |
---|---|
removeLoadStateListener |
open fun addPagedListListener(
listener: AsyncPagedListDiffer.PagedListListener<T>
): Unit
Add a PagedListListener
to receive updates when the current PagedList
changes.
Parameters | |
---|---|
listener: AsyncPagedListDiffer.PagedListListener<T> |
Listener to receive updates. |
See also | |
---|---|
currentList |
|
removePagedListListener |
fun addPagedListListener(callback: (PagedList<T>?, PagedList<T>?) -> Unit): Unit
Add a callback to receive updates when the current PagedList
changes.
See also | |
---|---|
currentList |
|
removePagedListListener |
open fun getItem(index: Int): T?
Get the item from the current PagedList at the specified index.
Note that this operates on both loaded items and null padding within the PagedList.
Parameters | |
---|---|
index: Int |
Index of item to get, must be >= 0, and < |
Returns | |
---|---|
T? |
The item, or null, if a null placeholder is at the specified position. |
Throws | |
---|---|
kotlin.IndexOutOfBoundsException |
if |
open fun removeLoadStateListener(listener: (LoadType, LoadState) -> Unit): Unit
Remove a previously registered LoadState
listener.
See also | |
---|---|
currentList |
|
addPagedListListener |
open fun removePagedListListener(
listener: AsyncPagedListDiffer.PagedListListener<T>
): Unit
Remove a previously registered PagedListListener
.
Parameters | |
---|---|
listener: AsyncPagedListDiffer.PagedListListener<T> |
Previously registered listener. |
See also | |
---|---|
currentList |
|
addPagedListListener |
fun removePagedListListener(callback: (PagedList<T>?, PagedList<T>?) -> Unit): Unit
Remove a previously registered callback via addPagedListListener
.
See also | |
---|---|
currentList |
|
addPagedListListener |
open fun submitList(pagedList: PagedList<T>?): Unit
Pass a new PagedList
to the differ.
If a PagedList is already present, a diff will be computed asynchronously on a background thread. When the diff is computed, it will be applied (dispatched to the ListUpdateCallback), and the new PagedList will be swapped in as the currentList
.
Parameters | |
---|---|
pagedList: PagedList<T>? |
The new PagedList. |
open fun submitList(pagedList: PagedList<T>?, commitCallback: Runnable?): Unit
Pass a new PagedList to the differ.
If a PagedList is already present, a diff will be computed asynchronously on a background thread. When the diff is computed, it will be applied (dispatched to the ListUpdateCallback), and the new PagedList will be swapped in as the current list
.
The commit callback can be used to know when the PagedList is committed, but note that it may not be executed. If PagedList B is submitted immediately after PagedList A, and is committed directly, the callback associated with PagedList A will not be run.
Parameters | |
---|---|
pagedList: PagedList<T>? |
The new |
commitCallback: Runnable? |
Optional runnable that is executed when the PagedList is committed, if it is committed. |
Throws | |
---|---|
kotlin.IllegalStateException |
if previous PagedList wasn't snapshotted correctly. |