added in version 22.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

Summary: Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

CursorObjectAdapter

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class CursorObjectAdapter
extends ObjectAdapter

java.lang.Object
↳	android.support.v17.leanback.widget.ObjectAdapter
	↳	android.support.v17.leanback.widget.CursorObjectAdapter

---

An ObjectAdapter implemented with a Cursor.

Summary

Inherited constants
From class android.support.v17.leanback.widget.ObjectAdapter int NO_ID Indicates that an id has not been set.

Public constructors
CursorObjectAdapter(PresenterSelector presenterSelector) Constructs an adapter with the given PresenterSelector.
CursorObjectAdapter(Presenter presenter) Constructs an adapter that uses the given Presenter for all items.
CursorObjectAdapter() Constructs an adapter.

Public methods
void	changeCursor(Cursor cursor) Changes the underlying cursor to a new cursor.
void	close() Closes this adapter, closing the backing Cursor as well.
Object	get(int index) Returns the item for the given position.
final Cursor	getCursor() Returns the Cursor backing the adapter.
final CursorMapper	getMapper() Returns the CursorMapper used to convert Cursor rows into Objects.
boolean	isClosed() Returns true if the adapter, and hence the backing Cursor, is closed; false otherwise.
boolean	isImmediateNotifySupported() Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise.
final void	setMapper(CursorMapper mapper) Sets the CursorMapper used to convert Cursor rows into Objects.
int	size() Returns the number of items in the adapter.
Cursor	swapCursor(Cursor cursor) Swap in a new Cursor, returning the old Cursor.

Protected methods
final void	invalidateCache(int index) Removes an item from the cache.
final void	invalidateCache(int index, int count) Removes count items starting at index.
void	onCursorChanged() Called whenever the cursor changes.
void	onMapperChanged() Called when setMapper(CursorMapper) is called and a different mapper is provided.

Inherited methods
From class android.support.v17.leanback.widget.ObjectAdapter abstract Object get(int position) Returns the item for the given position. long getId(int position) Returns the id for the given position. final Presenter getPresenter(Object item) Returns the Presenter for the given item from the adapter. final PresenterSelector getPresenterSelector() Returns the presenter selector for this ObjectAdapter. final boolean hasStableIds() Returns true if the item ids are stable across changes to the underlying data. boolean isImmediateNotifySupported() Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise. final void notifyChanged() Notifies UI that the underlying data has changed. final void notifyItemMoved(int fromPosition, int toPosition) Notifies UI that item at fromPosition has been moved to toPosition. final void notifyItemRangeChanged(int positionStart, int itemCount, Object payload) Notifies UI that some items has changed. final void notifyItemRangeChanged(int positionStart, int itemCount) Notifies UI that some items has changed. final void notifyItemRangeInserted(int positionStart, int itemCount) Notifies UI that new items has been inserted. final void notifyItemRangeRemoved(int positionStart, int itemCount) Notifies UI that some items that has been removed. void onHasStableIdsChanged() Called when setHasStableIds(boolean) is called and the status of stable ids has changed. void onPresenterSelectorChanged() Called when setPresenterSelector(PresenterSelector) is called and the PresenterSelector differs from the previous one. final void registerObserver(ObjectAdapter.DataObserver observer) Registers a DataObserver for data change notifications. final void setHasStableIds(boolean hasStableIds) Sets whether the item ids are stable across changes to the underlying data. final void setPresenterSelector(PresenterSelector presenterSelector) Sets the presenter selector. abstract int size() Returns the number of items in the adapter. final void unregisterAllObservers() Unregisters all DataObservers for this ObjectAdapter. final void unregisterObserver(ObjectAdapter.DataObserver observer) Unregisters a DataObserver for data change notifications.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public constructors

CursorObjectAdapter

added in version 22.1.0

CursorObjectAdapter (PresenterSelector presenterSelector)

Constructs an adapter with the given PresenterSelector.

Parameters
presenterSelector	PresenterSelector

CursorObjectAdapter

added in version 22.1.0

CursorObjectAdapter (Presenter presenter)

Constructs an adapter that uses the given Presenter for all items.

Parameters
presenter	Presenter

CursorObjectAdapter

added in version 22.1.0

CursorObjectAdapter ()

Constructs an adapter.

Public methods

changeCursor

added in version 22.1.0

void changeCursor (Cursor cursor)

Changes the underlying cursor to a new cursor. If there is an existing cursor it will be closed if it is different than the new cursor.

Parameters
cursor	Cursor: The new cursor to be used.

close

added in version 22.1.0

void close ()

Closes this adapter, closing the backing Cursor as well.

get

added in version 22.1.0

Object get (int index)

Returns the item for the given position.

Parameters
index	int

Returns
Object

getCursor

added in version 22.1.0

Cursor getCursor ()

Returns the Cursor backing the adapter.

Returns
Cursor

getMapper

added in version 22.1.0

CursorMapper getMapper ()

Returns the CursorMapper used to convert Cursor rows into Objects.

Returns
CursorMapper

isClosed

added in version 22.1.0

boolean isClosed ()

Returns true if the adapter, and hence the backing Cursor, is closed; false otherwise.

Returns
boolean

isImmediateNotifySupported

added in version 25.1.0

boolean isImmediateNotifySupported ()

Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise.

Returns
boolean

setMapper

added in version 22.1.0

void setMapper (CursorMapper mapper)

Sets the CursorMapper used to convert Cursor rows into Objects.

Parameters
mapper	CursorMapper

size

added in version 22.1.0

int size ()

Returns the number of items in the adapter.

Returns
int

swapCursor

added in version 22.1.0

Cursor swapCursor (Cursor cursor)

Swap in a new Cursor, returning the old Cursor. Unlike changeCursor(Cursor), the returned old Cursor is not closed.

Parameters
cursor	Cursor: The new cursor to be used.

Returns
Cursor

Protected methods

invalidateCache

added in version 22.1.0

void invalidateCache (int index)

Removes an item from the cache. This will force the item to be re-read from the data source the next time get(int) is called.

Parameters
index	int

invalidateCache

added in version 22.1.0

void invalidateCache (int index, 
                int count)

Removes count items starting at index.

Parameters
index	int
count	int

onCursorChanged

added in version 22.1.0

void onCursorChanged ()

Called whenever the cursor changes.