io.realm

Class RealmRecyclerViewAdapter<T extends io.realm.RealmModel,S extends RecyclerView.ViewHolder>

java.lang.Object

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

io.realm.RealmRecyclerViewAdapter<T,S>

Type Parameters:

T - type of RealmModel stored in the adapter.

S - type of RecyclerView.ViewHolder used in the adapter.

public abstract class RealmRecyclerViewAdapter<T extends io.realm.RealmModel,S extends RecyclerView.ViewHolder>
extends RecyclerView.Adapter<S>

The RealmBaseRecyclerAdapter class is an abstract utility class for binding RecyclerView UI elements to Realm data.

This adapter will automatically handle any updates to its data and call notifyDataSetChanged(), notifyItemInserted(), notifyItemRemoved() or notifyItemRangeChanged( as appropriate.

The RealmAdapter will stop receiving updates if the Realm instance providing the OrderedRealmCollection is closed.

Constructor Summary

Constructors

Constructor and Description
RealmRecyclerViewAdapter(io.realm.OrderedRealmCollection<T> data, boolean autoUpdate)

Method Summary

Modifier and Type	Method and Description
io.realm.OrderedRealmCollection<T>	getData() Returns data associated with this adapter.
T	getItem(int index) Returns the item associated with the specified position.
int	getItemCount()
long	getItemId(int index) Returns the current ID for an item.
void	onAttachedToRecyclerView(RecyclerView recyclerView)
void	onDetachedFromRecyclerView(RecyclerView recyclerView)
void	updateData(io.realm.OrderedRealmCollection<T> data) Updates the data associated to the Adapter.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmRecyclerViewAdapter

public RealmRecyclerViewAdapter(@Nullable
                                io.realm.OrderedRealmCollection<T> data,
                                boolean autoUpdate)

Method Detail

onAttachedToRecyclerView

public void onAttachedToRecyclerView(RecyclerView recyclerView)

Overrides:

onAttachedToRecyclerView in class RecyclerView.Adapter<S extends RecyclerView.ViewHolder>

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(RecyclerView recyclerView)

Overrides:

onDetachedFromRecyclerView in class RecyclerView.Adapter<S extends RecyclerView.ViewHolder>

getItemId

public long getItemId(int index)

Returns the current ID for an item. Note that item IDs are not stable so you cannot rely on the item ID being the same after notifyDataSetChanged() or updateData(OrderedRealmCollection) has been called.

Overrides:

getItemId in class RecyclerView.Adapter<S extends RecyclerView.ViewHolder>

Parameters:

index - position of item in the adapter.

Returns:

current item ID.

getItemCount

public int getItemCount()

Specified by:

getItemCount in class RecyclerView.Adapter<S extends RecyclerView.ViewHolder>

getItem

@Nullable
public T getItem(int index)

Returns the item associated with the specified position. Can return null if provided Realm instance by OrderedRealmCollection is closed.

Parameters:

index - index of the item.

Returns:

the item at the specified position, null if adapter data is not valid.

getData

@Nullable
public io.realm.OrderedRealmCollection<T> getData()

Returns data associated with this adapter.

Returns:

adapter data.

updateData

public void updateData(@Nullable
                       io.realm.OrderedRealmCollection<T> data)

Updates the data associated to the Adapter. Useful when the query has been changed. If the query does not change you might consider using the automaticUpdate feature.

Parameters:

data - the new OrderedRealmCollection to display.