SortedList

Used by indexOf(Object) when he item cannot be found in the list.

Creates a new SortedList of type T.

Creates a new SortedList of type T.

Adds the given item to the list. If this is a new item, SortedList calls onInserted(int, int).

If the item already exists in the list and its sorting criteria is not changed, it is replaced with the existing Item. SortedList uses areItemsTheSame(Object, Object) to check if two items are the same item and uses areContentsTheSame(Object, Object) to decide whether it should call onChanged(int, int) or not. In both cases, it always removes the reference to the old item and puts the new item into the backing array even if areContentsTheSame(Object, Object) returns false.

If the sorting criteria of the item is changed, SortedList won't be able to find its duplicate in the list which will result in having a duplicate of the Item in the list. If you need to update sorting criteria of an item that already exists in the list, use updateItemAt(int, Object). You can find the index of the item using indexOf(Object) before you update the object.

Adds the given items to the list. Does not modify the input.

Adds the given items to the list. Does not modify the input.

Adds the given items to the list. Equivalent to calling add(T) in a loop, except the callback events may be in a different order/granularity since addAll can batch them for better performance.

If allowed, may modify the input array and even take the ownership over it in order to avoid extra memory allocation during sorting and deduplication.

Batches adapter updates that happen between calling this method until calling endBatchedUpdates(). For example, if you add multiple items in a loop and they are placed into consecutive indices, SortedList calls onInserted(int, int) only once with the proper item count. If an event cannot be merged with the previous event, the previous event is dispatched to the callback instantly.

After running your data updates, you must call endBatchedUpdates() which will dispatch any deferred data change event to the current callback.

A sample implementation may look like this:

     mSortedList.beginBatchedUpdates();
     try {
         mSortedList.add(item1)
         mSortedList.add(item2)
         mSortedList.remove(item3)
         ...
     } finally {
         mSortedList.endBatchedUpdates();
     }
 

Instead of using this method to batch calls, you can use a Callback that extends SortedList.BatchedCallback. In that case, you must make sure that you are manually calling dispatchLastEvent() right after you complete your data changes. Failing to do so may create data inconsistencies with the Callback.

If the current Callback in an instance of SortedList.BatchedCallback, calling this method has no effect.

Removes all items from the SortedList.

Ends the update transaction and dispatches any remaining event to the callback.

Returns the item at the given index.

Returns the position of the provided item.

This method can be used to recalculate the position of the item at the given index, without triggering an onChanged(int, int) callback.

If you are editing objects in the list such that their position in the list may change but you don't want to trigger an onChange animation, you can use this method to re-position it. If the item changes position, SortedList will call onMoved(int, int) without calling onChanged(int, int).

A sample usage may look like:

     final int position = mSortedList.indexOf(item);
     item.incrementPriority(); // assume items are sorted by priority
     mSortedList.recalculatePositionOfItemAt(position);
 

Removes the provided item from the list and calls onRemoved(int, int).

Removes the item at the given index and calls onRemoved(int, int).

The number of items in the list.

Updates the item at the given index and calls onChanged(int, int) and/or onMoved(int, int) if necessary.

You can use this method if you need to change an existing Item such that its position in the list may change.

If the new object is a different object (get(index) != item) and areContentsTheSame(Object, Object) returns true, SortedList avoids calling onChanged(int, int) otherwise it calls onChanged(int, int).

If the new position of the item is different than the provided index, SortedList calls onMoved(int, int).