SortedList.BatchedCallback
class SortedList.BatchedCallback<T2> : SortedList.Callback
| kotlin.Any | ||
| ↳ | androidx.recyclerview.widget.SortedList.Callback | |
| ↳ | androidx.recyclerview.widget.SortedList.BatchedCallback | |
A callback implementation that can batch notify events dispatched by the SortedList.
This class can be useful if you want to do multiple operations on a SortedList but don't want to dispatch each event one by one, which may result in a performance issue.
For example, if you are going to add multiple items to a SortedList, BatchedCallback call convert individual onInserted(index, 1) calls into one onInserted(index, N) if items are added into consecutive indices. This change can help RecyclerView resolve changes much more easily.
If consecutive changes in the SortedList are not suitable for batching, BatchingCallback dispatches them as soon as such case is detected. After your edits on the SortedList is complete, you must always call dispatchLastEvent to flush all changes to the Callback.
Summary
Public constructors |
|---|
BatchedCallback(wrappedCallback: SortedList.Callback<T2!>!)Creates a new BatchedCallback that wraps the provided Callback. |
Public functions |
|
|---|---|
Boolean |
areContentsTheSame(oldItem: T2!, newItem: T2!)Called by the SortedList when it wants to check whether two items have the same data or not. |
Boolean |
areItemsTheSame(item1: T2!, item2: T2!)Called by the SortedList to decide whether two objects represent the same Item or not. |
Int |
compare(o1: T2!, o2: T2!)Similar to java.util.Comparator#compare(Object, Object), should compare two and return how they should be ordered. |
Unit |
This method dispatches any pending event notifications to the wrapped Callback. |
Any? |
getChangePayload(item1: T2!, item2: T2!)When #areItemsTheSame(T2, T2) returns true} for two items and #areContentsTheSame(T2, T2) returns false for them, calls this method to get a payload about the change. |
Unit |
Called by the SortedList when the item at the given position is updated. |
Unit |
|
Unit |
onInserted(position: Int, count: Int)Called when count} number of items are inserted at the given position. |
Unit |
Called when an item changes its position in the list. |
Unit |
Called when count} number of items are removed from the given position. |
Inherited functions |
||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||
Public constructors
BatchedCallback
BatchedCallback(wrappedCallback: SortedList.Callback<T2!>!)
Creates a new BatchedCallback that wraps the provided Callback.
| Parameters | |
|---|---|
wrappedCallback: SortedList.Callback<T2!>! |
The Callback which should received the data change callbacks. Other method calls (e.g. compare from the SortedList are directly forwarded to this Callback. |
Public functions
areContentsTheSame
fun areContentsTheSame(oldItem: T2!, newItem: T2!): Boolean
Called by the SortedList when it wants to check whether two items have the same data or not. SortedList uses this information to decide whether it should call #onChanged(int, int) or not.
SortedList uses this method to check equality instead of Object#equals(Object) so that you can change its behavior depending on your UI.
For example, if you are using SortedList with a RecyclerView.Adapter, you should return whether the items' visual representations are the same or not.
areItemsTheSame
fun areItemsTheSame(item1: T2!, item2: T2!): Boolean
Called by the SortedList to decide whether two objects represent the same Item or not.
For example, if your items have unique ids, this method should check their equality.
compare
fun compare(o1: T2!, o2: T2!): Int
Similar to java.util.Comparator#compare(Object, Object), should compare two and return how they should be ordered.
dispatchLastEvent
fun dispatchLastEvent(): Unit
This method dispatches any pending event notifications to the wrapped Callback. You must always call this method after you are done with editing the SortedList.
getChangePayload
fun getChangePayload(item1: T2!, item2: T2!): Any?
When #areItemsTheSame(T2, T2) returns true} for two items and #areContentsTheSame(T2, T2) returns false for them, calls this method to get a payload about the change.
For example, if you are using with , you can return the particular field that changed in the item and your ItemAnimator can use that information to run the correct animation.
Default implementation returns null}.
onChanged
fun onChanged(position: Int, count: Int): Unit
Called by the SortedList when the item at the given position is updated.
onInserted
fun onInserted(position: Int, count: Int): Unit
Called when count} number of items are inserted at the given position.
onMoved
fun onMoved(fromPosition: Int, toPosition: Int): Unit
Called when an item changes its position in the list.
onRemoved
fun onRemoved(position: Int, count: Int): Unit
Called when count} number of items are removed from the given position.