AsyncPagedListDiffer
public
class
AsyncPagedListDiffer
extends Object
java.lang.Object | |
↳ | android.arch.paging.AsyncPagedListDiffer<T> |
Helper object for mapping a PagedList
into a
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(PagedList)
. 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(int)
and getItemCount()
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 = ViewModelProviders.of(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> mDiffer = new AsyncPagedListDiffer(this, DIFF_CALLBACK); @Override public int getItemCount() { return mDiffer.getItemCount(); } public void submitList(PagedList<User> pagedList) { mDiffer.submitList(pagedList); } @Override public void onBindViewHolder(UserViewHolder holder, int position) { User user = mDiffer.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); } } }
Summary
Public constructors | |
---|---|
AsyncPagedListDiffer(Adapter adapter, ItemCallback<T> diffCallback)
Convenience for |
|
AsyncPagedListDiffer(ListUpdateCallback listUpdateCallback, AsyncDifferConfig<T> config)
|
Public methods | |
---|---|
PagedList<T>
|
getCurrentList()
Returns the PagedList currently being displayed by the differ. |
T
|
getItem(int index)
Get the item from the current PagedList at the specified index. |
int
|
getItemCount()
Get the number of items currently presented by this Differ. |
void
|
submitList(PagedList<T> pagedList)
Pass a new PagedList to the differ. |
Inherited methods | |
---|---|
Public constructors
AsyncPagedListDiffer
AsyncPagedListDiffer (Adapter adapter, ItemCallback<T> diffCallback)
Convenience for AsyncPagedListDiffer(new AdapterListUpdateCallback(adapter),
new AsyncDifferConfig.Builder<T>(diffCallback).build();
Parameters | |
---|---|
adapter |
Adapter : Adapter that will receive update signals. |
diffCallback |
ItemCallback : The DiffUtil.ItemCallback instance to
compare items in the list.
|
AsyncPagedListDiffer
AsyncPagedListDiffer (ListUpdateCallback listUpdateCallback, AsyncDifferConfig<T> config)
Parameters | |
---|---|
listUpdateCallback |
ListUpdateCallback |
config |
AsyncDifferConfig |
Public methods
getCurrentList
PagedList<T> getCurrentList ()
Returns the PagedList currently being displayed by the differ.
This is not necessarily the most recent list passed to submitList(PagedList)
,
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 null. |
getItem
T getItem (int index)
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 < getItemCount() . |
Returns | |
---|---|
T |
The item, or null, if a null placeholder is at the specified position. |
getItemCount
int getItemCount ()
Get the number of items currently presented by this Differ. This value can be directly
returned to getItemCount()
.
Returns | |
---|---|
int |
Number of items being presented. |
submitList
void submitList (PagedList<T> pagedList)
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
.
Parameters | |
---|---|
pagedList |
PagedList : The new PagedList.
|
Interfaces
Classes
- AsyncPagedListDiffer
- DataSource
- DataSource.Factory
- ItemKeyedDataSource
- ItemKeyedDataSource.LoadCallback
- ItemKeyedDataSource.LoadInitialCallback
- ItemKeyedDataSource.LoadInitialParams
- ItemKeyedDataSource.LoadParams
- LivePagedListBuilder
- PagedList
- PagedList.BoundaryCallback
- PagedList.Builder
- PagedList.Callback
- PagedList.Config
- PagedList.Config.Builder
- PagedListAdapter
- PageKeyedDataSource
- PageKeyedDataSource.LoadCallback
- PageKeyedDataSource.LoadInitialCallback
- PageKeyedDataSource.LoadInitialParams
- PageKeyedDataSource.LoadParams
- PositionalDataSource
- PositionalDataSource.LoadInitialCallback
- PositionalDataSource.LoadInitialParams
- PositionalDataSource.LoadRangeCallback
- PositionalDataSource.LoadRangeParams
- RxPagedListBuilder