com.devbrackets.android.recyclerext.adapter

Class RecyclerListAdapter<VH extends android.support.v7.widget.RecyclerView.ViewHolder,T>

java.lang.Object

android.support.v7.widget.RecyclerView.Adapter<VH>

com.devbrackets.android.recyclerext.adapter.RecyclerListAdapter<VH,T>

Type Parameters:

VH - The ViewHolder to use

T - The object type for the list

Direct Known Subclasses:

RecyclerHeaderListAdapter

public abstract class RecyclerListAdapter<VH extends android.support.v7.widget.RecyclerView.ViewHolder,T>
extends android.support.v7.widget.RecyclerView.Adapter<VH>

A basic adapter with support for lists to simplify integrations.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<T>	items
protected java.lang.Object	lock
protected boolean	notifyOnChange

Constructor Summary

Constructors

Constructor and Description
RecyclerListAdapter() Creates an adapter with no initial items
RecyclerListAdapter(java.util.List<T> itemList) Creates an adapter with the specified items

Method Summary

Modifier and Type	Method and Description
void	add(int position, T item) Adds the specified item to the list with the specified position
void	add(T item) Adds the specified item to the end of the list
void	addAll(java.util.List<T> itemList) Adds all the specified items to the list
void	clear() Clears all the items from the list
T	getItem(int position) Retrieves the item with the specified position in the adapter.
int	getItemCount() Retrieves the number of items for the adapter.
int	getPosition(T item) Searches the items for the specified object and returns the index of the first occurrence.
void	move(int originalPosition, int endPosition) Moves the item at the originalPosition to the endPosition.
void	notifyItemsSwapped(int positionOne, int positionTwo) Notify any registered observers that the item reflected at positionOne has been moved to positionTwo and vice-versa.
void	remove(int position) Removes the item with the specified position from the list
void	remove(T item) Removes the specified item from the list
void	set(java.util.List<T> itemList) Clears all the current items in the list and adds all the specified items to the list
void	setNotifyOnChange(boolean notifyOnChange) Control whether methods that change the list automatically call notifyDataSetChanged().
void	sort(java.util.Comparator<? super T> comparator) Sorts the items in the adapter using the specified comparator
void	swap(int positionOne, int positionTwo) Swaps the items with the specified positions in the list.

Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

bindViewHolder, createViewHolder, getItemId, getItemViewType, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onAttachedToRecyclerView, onBindViewHolder, onBindViewHolder, onCreateViewHolder, onDetachedFromRecyclerView, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver

Methods inherited from class java.lang.Object

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

Field Detail

items

@Nullable
protected java.util.List<T> items

notifyOnChange

protected boolean notifyOnChange

lock

protected final java.lang.Object lock

Constructor Detail

RecyclerListAdapter

public RecyclerListAdapter()

Creates an adapter with no initial items

RecyclerListAdapter

public RecyclerListAdapter(@Nullable
                           java.util.List<T> itemList)

Creates an adapter with the specified items

Parameters:

itemList - The list of initial items for the adapter

Method Detail

getItemCount

public int getItemCount()

Retrieves the number of items for the adapter. By default this will use the number of items in the list.

Specified by:

getItemCount in class android.support.v7.widget.RecyclerView.Adapter<VH extends android.support.v7.widget.RecyclerView.ViewHolder>

Returns:

The number of items in the adapter

getItem

@Nullable
public T getItem(int position)

Retrieves the item with the specified position in the adapter. If the position is not in the list of items then null will be returned.

Parameters:

position - The items position in the list

Returns:

The item at the specified position in the list or null

getPosition

public int getPosition(T item)

Searches the items for the specified object and returns the index of the first occurrence.

Parameters:

item - The object to search for

Returns:

The index of the first occurrence of the object or -1 if the object was not found

clear

public void clear()

Clears all the items from the list

set

public void set(@NonNull
                java.util.List<T> itemList)

Clears all the current items in the list and adds all the specified items to the list

Parameters:

itemList - the list of items to add

add

public void add(T item)

Adds the specified item to the end of the list

Parameters:

item - The item to add to the list

add

public void add(int position,
                T item)

Adds the specified item to the list with the specified position

Parameters:

position - The position to insert the item at

item - The item to add to the list

addAll

public void addAll(@NonNull
                   java.util.List<T> itemList)

Adds all the specified items to the list

Parameters:

itemList - The list of items to add

remove

public void remove(T item)

Removes the specified item from the list

Parameters:

item - The item to remove from the list

remove

public void remove(int position)

Removes the item with the specified position from the list

Parameters:

position - The position for the item to remove

swap

public void swap(int positionOne,
                 int positionTwo)

Swaps the items with the specified positions in the list. If either position is out of bounds then no action will be performed.

Parameters:

positionOne - The position of the first item to swap

positionTwo - The position of the second item to swap

move

public void move(int originalPosition,
                 int endPosition)

Moves the item at the originalPosition to the endPosition. If the endPosition is greater than the number of items, it will be added to the end of the list instead.

Parameters:

originalPosition - The position the object is in that needs to be moved

endPosition - The end position for the item being moved

notifyItemsSwapped

public void notifyItemsSwapped(int positionOne,
                               int positionTwo)

Notify any registered observers that the item reflected at positionOne has been moved to positionTwo and vice-versa.

This is a structural change event. Representations of other existing items in the data set are still considered up to date and will not be rebound, though their positions may be altered.

Parameters:

positionOne - The position of the first item moved

positionTwo - The position of the second item moved

setNotifyOnChange

public void setNotifyOnChange(boolean notifyOnChange)

Control whether methods that change the list automatically call notifyDataSetChanged(). If set to false, caller must manually call notifyDataSetChanged() to have the changes reflected in the attached view. The default is true, and calling notifyDataSetChanged() resets the flag to true.

Parameters:

notifyOnChange - if true, modifications to the list will automatically call notifyDataSetChanged()

sort

public void sort(java.util.Comparator<? super T> comparator)

Sorts the items in the adapter using the specified comparator

Parameters:

comparator - The comparator to sort the list with