Android 12 Developer Preview is here! Try it out, and give us your feedback!


open class AsyncPagedListDiffer<T : Any>
   ↳ androidx.paging.AsyncPagedListDiffer

Helper object for mapping a androidx.paging.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. 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:

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 {
    public void onCreate(Bundle savedState) {
        MyViewModel viewModel = new ViewModelProvider(this).get(MyViewModel.class);
        RecyclerView recyclerView = findViewById(;
        final UserAdapter adapter = new UserAdapter();
        viewModel.usersList.observe(this, pagedList -> adapter.submitList(pagedList));

class UserAdapter extends RecyclerView.Adapter&lt;UserViewHolder> {
    private final AsyncPagedListDiffer&lt;User> differ =
            new AsyncPagedListDiffer(this, DIFF_CALLBACK);
    public int getItemCount() {
        return differ.getItemCount();
    public void submitList(PagedList&lt;User> pagedList) {
    public void onBindViewHolder(UserViewHolder holder, int position) {
        User user = differ.getItem(position);
        if (user != null) {
        } else {
            // Null defines a placeholder item - AsyncPagedListDiffer will automatically
            // invalidate this row when the actual object is loaded from the database
    public static final DiffUtil.ItemCallback&lt;User> DIFF_CALLBACK =
            new DiffUtil.ItemCallback&lt;User>() {
        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();
        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);


Nested classes

Listener for when the current PagedList is updated.

Public constructors
<init>(adapter: RecyclerView.Adapter<*>, diffCallback: DiffUtil.ItemCallback<T>)

Convenience for

<init>(listUpdateCallback: ListUpdateCallback, config: AsyncDifferConfig<T>)

Public methods
open Unit

Add a LoadState listener to observe the loading state of the current PagedList.

open Unit

Add a PagedListListener to receive updates when the current PagedList changes.

addPagedListListener(callback: (PagedList<T>?, PagedList<T>?) -> Unit)

Add a callback to receive updates when the current PagedList changes.

open T?
getItem(index: Int)

Get the item from the current PagedList at the specified index.

open Unit

Remove a previously registered LoadState listener.

open Unit

Remove a previously registered PagedListListener.

removePagedListListener(callback: (PagedList<T>?, PagedList<T>?) -> Unit)

Remove a previously registered callback via addPagedListListener.

open Unit
submitList(pagedList: PagedList<T>?)

Pass a new PagedList to the differ.

open Unit
submitList(pagedList: PagedList<T>?, commitCallback: Runnable?)

Pass a new PagedList to the differ.

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


    adapter: RecyclerView.Adapter<*>,
    diffCallback: DiffUtil.ItemCallback<T>)

Convenience for

adapter: RecyclerView.Ada