io.realm

Class RealmRecyclerViewAdapter<T extends io.realm.RealmModel,S extends android.support.v7.widget.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 android.support.v7.widget.RecyclerView.ViewHolder>
extends android.support.v7.widget.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.

If the adapter contains Realm model classes with a primary key that is either an int or a long, call setHasStableIds(true) in the constructor and override RecyclerView.Adapter.getItemId(int) as described by the Javadoc in that method.

See Also:

RecyclerView.Adapter#setHasStableIds(boolean), RecyclerView.Adapter#getItemId(int)

Constructor Summary

Constructors

Constructor and Description
RealmRecyclerViewAdapter(io.realm.OrderedRealmCollection<T> data, boolean autoUpdate) This is equivalent to RealmRecyclerViewAdapter(data, autoUpdate, true).
RealmRecyclerViewAdapter(io.realm.OrderedRealmCollection<T> data, boolean autoUpdate, boolean updateOnModification)

Method Summary

Modifier and Type	Method and Description
int	dataOffset() Returns the number of header elements before the Realm collection elements.
io.realm.OrderedRealmCollection<T>	getData() Returns data associated with this adapter.
T	getItem(int index) Returns the item in the underlying data associated with the specified position.
int	getItemCount()
void	onAttachedToRecyclerView(android.support.v7.widget.RecyclerView recyclerView)
void	onDetachedFromRecyclerView(android.support.v7.widget.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, getItemId, 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)

This is equivalent to RealmRecyclerViewAdapter(data, autoUpdate, true).

Parameters:

data - collection data to be used by this adapter.

autoUpdate - when it is false, the adapter won't be automatically updated when collection data changes.

See Also:

RealmRecyclerViewAdapter(OrderedRealmCollection, boolean, boolean)

RealmRecyclerViewAdapter

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

Parameters:

data - collection data to be used by this adapter.

autoUpdate - when it is false, the adapter won't be automatically updated when collection data changes.

updateOnModification - when it is true, this adapter will be updated when deletions, insertions or modifications happen to the collection data. When it is false, only deletions and insertions will trigger the updates. This param will be ignored if autoUpdate is false.

Method Detail

dataOffset

public int dataOffset()

Returns the number of header elements before the Realm collection elements. This is needed so all indexes reported by the OrderedRealmCollectionChangeListener can be adjusted correctly. Failing to override can cause the wrong elements to animate and lead to runtime exceptions.

Returns:

The number of header elements in the RecyclerView before the collection elements. Default is 0.

onAttachedToRecyclerView

public void onAttachedToRecyclerView(android.support.v7.widget.RecyclerView recyclerView)

Overrides:

onAttachedToRecyclerView in class android.support.v7.widget.RecyclerView.Adapter<S extends android.support.v7.widget.RecyclerView.ViewHolder>

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(android.support.v7.widget.RecyclerView recyclerView)

Overrides:

onDetachedFromRecyclerView in class android.support.v7.widget.RecyclerView.Adapter<S extends android.support.v7.widget.RecyclerView.ViewHolder>

getItemCount

public int getItemCount()

Specified by:

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

getItem

@Nullable
public T getItem(int index)

Returns the item in the underlying data associated with the specified position. This method will return null if the Realm instance has been closed or the index is outside the range of valid adapter data (which e.g. can happen if getItemCount() is modified to account for header or footer views. Also, this method does not take into account any header views. If these are present, modify the index parameter accordingly first.

Parameters:

index - index of the item in the original collection backing this adapter.

Returns:

the item at the specified position or null if the position does not exists or the adapter data are no longer 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.