DiffUtil.DiffResult
public class DiffUtil.DiffResult
This class holds the information about the result of a calculateDiff call.
You can consume the updates in a DiffResult via dispatchUpdatesTo or directly stream the results into a RecyclerView.Adapter via dispatchUpdatesTo.
Summary
Constants |
|
|---|---|
static final int |
NO_POSITION = -1Signifies an item not present in the list. |
Public methods |
|
|---|---|
int |
convertNewPositionToOld(@IntRange(from = 0) int newListPosition)Given a position in the new list, returns the position in the old list, or |
int |
convertOldPositionToNew(@IntRange(from = 0) int oldListPosition)Given a position in the old list, returns the position in the new list, or |
void |
dispatchUpdatesTo(@NonNull RecyclerView.Adapter adapter)Dispatches the update events to the given adapter. |
void |
dispatchUpdatesTo(@NonNull ListUpdateCallback updateCallback)Dispatches update operations to the given Callback. |
Constants
NO_POSITION
public static final int NO_POSITION = -1
Signifies an item not present in the list.
Public methods
convertNewPositionToOld
public int convertNewPositionToOld(@IntRange(from = 0) int newListPosition)
Given a position in the new list, returns the position in the old list, or NO_POSITION if it was removed.
| Parameters | |
|---|---|
@IntRange(from = 0) int newListPosition |
Position of item in new list |
| Returns | |
|---|---|
int |
Position of item in old list, or |
| See also | |
|---|---|
NO_POSITION |
|
convertOldPositionToNew |
convertOldPositionToNew
public int convertOldPositionToNew(@IntRange(from = 0) int oldListPosition)
Given a position in the old list, returns the position in the new list, or NO_POSITION if it was removed.
| Parameters | |
|---|---|
@IntRange(from = 0) int oldListPosition |
Position of item in old list |
| Returns | |
|---|---|
int |
Position of item in new list, or |
| See also | |
|---|---|
NO_POSITION |
|
convertNewPositionToOld |
dispatchUpdatesTo
public void dispatchUpdatesTo(@NonNull RecyclerView.Adapter adapter)
Dispatches the update events to the given adapter.
For example, if you have an Adapter that is backed by a List, you can swap the list with the new one then call this method to dispatch all updates to the RecyclerView.
List oldList = mAdapter.getData();
DiffResult result = DiffUtil.calculateDiff(new MyCallback(oldList, newList));
mAdapter.setData(newList);
result.dispatchUpdatesTo(mAdapter); Note that the RecyclerView requires you to dispatch adapter updates immediately when you change the data (you cannot defer notify* calls). The usage above adheres to this rule because updates are sent to the adapter right after the backing data is changed, before RecyclerView tries to read it.
On the other hand, if you have another AdapterDataObserver that tries to process events synchronously, this may confuse that observer because the list is instantly moved to its final state while the adapter updates are dispatched later on, one by one. If you have such an AdapterDataObserver, you can use dispatchUpdatesTo to handle each modification manually.
| Parameters | |
|---|---|
@NonNull RecyclerView.Adapter adapter |
A RecyclerView adapter which was displaying the old list and will start displaying the new list. |
| See also | |
|---|---|
AdapterListUpdateCallback |
dispatchUpdatesTo
public void dispatchUpdatesTo(@NonNull ListUpdateCallback updateCallback)
Dispatches update operations to the given Callback.
These updates are atomic such that the first update call affects every update call that comes after it (the same as RecyclerView).
| Parameters | |
|---|---|
@NonNull ListUpdateCallback updateCallback |
The callback to receive the update operations. |
| See also | |
|---|---|
dispatchUpdatesTo |