me.tatarka.bindingcollectionadapter2.collections

Class DiffObservableList<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

me.tatarka.bindingcollectionadapter2.collections.DiffObservableList<T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

public class DiffObservableList<T>
extends java.util.AbstractList<T>

An ObservableList that uses DiffUtil to calculate and dispatch it's change updates. Note: Consider using AsyncDiffObservableList instead as it will automatically diff in a background thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DiffObservableList.Callback<T> Deprecated. Use DiffUtil.ItemCallback instead.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
DiffObservableList(<any> callback) Creates a new DiffObservableList of type T.
DiffObservableList(<any> callback, boolean detectMoves) Creates a new DiffObservableList of type T.
DiffObservableList(DiffObservableList.Callback<T> callback) Deprecated. The same behavior can be obtained with #DiffObservableList(DiffUtil.ItemCallback), though you may consider using AsyncDiffObservableList instead.
DiffObservableList(DiffObservableList.Callback<T> callback, boolean detectMoves) Deprecated. The same behavior can be obtained with #DiffObservableList(DiffUtil.ItemCallback, boolean), though you may consider using AsyncDiffObservableList instead.

Method Summary

Modifier and Type	Method and Description
void	addOnListChangedCallback(<any> listener)
DiffUtil.DiffResult	calculateDiff(java.util.List<T> newItems) Calculates the list of update operations that can convert this list into the given one.
T	get(int i)
void	removeOnListChangedCallback(<any> listener)
int	size()
void	update(java.util.List<T> newItems) Sets this list to the given items.
void	update(java.util.List<T> newItems, DiffUtil.DiffResult diffResult) Updates the contents of this list to the given one using the DiffResults to dispatch change notifications.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DiffObservableList

@Deprecated
public DiffObservableList(DiffObservableList.Callback<T> callback)

Deprecated. The same behavior can be obtained with #DiffObservableList(DiffUtil.ItemCallback), though you may consider using AsyncDiffObservableList instead.

Creates a new DiffObservableList of type T.

Parameters:

callback - The callback that controls the behavior of the DiffObservableList.

DiffObservableList

@Deprecated
public DiffObservableList(DiffObservableList.Callback<T> callback,
                                      boolean detectMoves)

Deprecated. The same behavior can be obtained with #DiffObservableList(DiffUtil.ItemCallback, boolean), though you may consider using AsyncDiffObservableList instead.

Creates a new DiffObservableList of type T.

Parameters:

callback - The callback that controls the behavior of the DiffObservableList.

detectMoves - True if DiffUtil should try to detect moved items, false otherwise.

DiffObservableList

public DiffObservableList(<any> callback)

Creates a new DiffObservableList of type T.

Parameters:

callback - The callback that controls the behavior of the DiffObservableList.

DiffObservableList

public DiffObservableList(<any> callback,
                          boolean detectMoves)

Creates a new DiffObservableList of type T.

Parameters:

callback - The callback that controls the behavior of the DiffObservableList.

detectMoves - True if DiffUtil should try to detect moved items, false otherwise.

Method Detail

calculateDiff

public DiffUtil.DiffResult calculateDiff(java.util.List<T> newItems)

Calculates the list of update operations that can convert this list into the given one.

Parameters:

newItems - The items that this list will be set to.

Returns:

A DiffResult that contains the information about the edit sequence to covert this list into the given one.

update

public void update(java.util.List<T> newItems,
                   DiffUtil.DiffResult diffResult)

Updates the contents of this list to the given one using the DiffResults to dispatch change notifications.

Parameters:

newItems - The items to set this list to.

diffResult - The diff results to dispatch change notifications.

update

public void update(java.util.List<T> newItems)

Sets this list to the given items. This is a convenience method for calling calculateDiff(List) followed by update(List, DiffUtil.DiffResult).

Warning! If the lists are large this operation may be too slow for the main thread. In that case, you should call calculateDiff(List) on a background thread and then update(List, DiffUtil.DiffResult) on the main thread.

Parameters:

newItems - The items to set this list to.

addOnListChangedCallback

public void addOnListChangedCallback(<any> listener)

removeOnListChangedCallback

public void removeOnListChangedCallback(<any> listener)

get

public T get(int i)

Specified by:

get in interface java.util.List<T>

Specified by:

get in class java.util.AbstractList<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<T>

Specified by:

size in class java.util.AbstractCollection<T>