com.globusltd.recyclerview.diff

Class SimpleDatasourcesDiffCallback<E>

java.lang.Object

Callback

com.globusltd.recyclerview.diff.DiffCallback

com.globusltd.recyclerview.diff.SimpleDatasourcesDiffCallback<E>

Type Parameters:

E - type of entity in the datasource.

All Implemented Interfaces:

ParameterizedDiffCallback<E>

public abstract class SimpleDatasourcesDiffCallback<E>
extends DiffCallback
implements ParameterizedDiffCallback<E>

A callback class used by DiffUtil while calculating the diff between two Datasources.

Constructor Summary

Constructors

Constructor and Description
SimpleDatasourcesDiffCallback(Datasource<? extends E> oldDatasource, Datasource<? extends E> newDatasource)
SimpleDatasourcesDiffCallback(Datasource<? extends E> oldDatasource, Datasource<? extends E> newDatasource, boolean shouldDetectMoves)

Method Summary

Modifier and Type	Method and Description
boolean	areContentsTheSame(int oldItemPosition, int newItemPosition)
boolean	areItemsTheSame(int oldItemPosition, int newItemPosition)
Object	getChangePayload(E oldItem, E newItem) When #areItemsTheSame(E, E) returns true for two items and #areContentsTheSame(E, E) returns false for them, DiffUtil calls this method to get a payload about the change.
Object	getChangePayload(int oldItemPosition, int newItemPosition)
int	getNewListSize()
int	getOldListSize()

Methods inherited from class com.globusltd.recyclerview.diff.DiffCallback

shouldDetectMoves

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.globusltd.recyclerview.diff.ParameterizedDiffCallback

areContentsTheSame, areItemsTheSame

Constructor Detail

SimpleDatasourcesDiffCallback

public SimpleDatasourcesDiffCallback(@NonNull
                                     Datasource<? extends E> oldDatasource,
                                     @NonNull
                                     Datasource<? extends E> newDatasource)

SimpleDatasourcesDiffCallback

public SimpleDatasourcesDiffCallback(@NonNull
                                     Datasource<? extends E> oldDatasource,
                                     @NonNull
                                     Datasource<? extends E> newDatasource,
                                     boolean shouldDetectMoves)

Method Detail

getOldListSize

public int getOldListSize()

getNewListSize

public int getNewListSize()

areItemsTheSame

public final boolean areItemsTheSame(int oldItemPosition,
                                     int newItemPosition)

areContentsTheSame

public final boolean areContentsTheSame(int oldItemPosition,
                                        int newItemPosition)

getChangePayload

@Nullable
public final Object getChangePayload(int oldItemPosition,
                                                int newItemPosition)

getChangePayload

@Nullable
public Object getChangePayload(@NonNull
                                          E oldItem,
                                          @NonNull
                                          E newItem)

When #areItemsTheSame(E, E) returns true for two items and #areContentsTheSame(E, E) returns false for them, DiffUtil calls this method to get a payload about the change.

For example, if you are using DiffUtil with RecyclerView, you can return the particular field that changed in the item and your RecyclerView.ItemAnimator can use that information to run the correct animation.

Default implementation returns null.

Specified by:

getChangePayload in interface ParameterizedDiffCallback<E>

Parameters:

oldItem - The item in the old datasource.

newItem - The item in the new datasource.

Returns:

A payload object that represents the change between the two datasources.