added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

SparseArrayObjectAdapter

public class SparseArrayObjectAdapter
extends ObjectAdapter

java.lang.Object
   ↳ androidx.leanback.widget.ObjectAdapter
     ↳ androidx.leanback.widget.SparseArrayObjectAdapter


An ObjectAdapter implemented with a SparseArray. This class maintains an array of objects where each object is associated with an integer key which determines its order relative to other objects.

Summary

Inherited constants

Public constructors

SparseArrayObjectAdapter(PresenterSelector presenterSelector)

Constructs an adapter with the given PresenterSelector.

SparseArrayObjectAdapter(Presenter presenter)

Constructs an adapter with the given Presenter.

SparseArrayObjectAdapter()

Constructs an adapter.

Public methods

void clear(int key)

Clears the given key and associated item from the adapter.

void clear()

Removes all items from this adapter, leaving it empty.

Object get(int position)

Returns the item for the given position.

int indexOf(Object item)

Returns the index for the given item in the adapter.

int indexOf(int key)

Returns the index for the given key in the adapter.

boolean isImmediateNotifySupported()

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

Object lookup(int key)

Returns the object for the given key, or null if no mapping for that key exists.

void notifyArrayItemRangeChanged(int positionStart, int itemCount)

Notify that the content of a range of items changed.

void set(int key, Object item)

Sets the item for the given key.

int size()

Returns the number of items in the adapter.

Inherited methods

Public constructors

SparseArrayObjectAdapter

added in version 1.0.0
public SparseArrayObjectAdapter (PresenterSelector presenterSelector)

Constructs an adapter with the given PresenterSelector.

Parameters
presenterSelector PresenterSelector

SparseArrayObjectAdapter

added in version 1.0.0
public SparseArrayObjectAdapter (Presenter presenter)

Constructs an adapter with the given Presenter.

Parameters
presenter Presenter

SparseArrayObjectAdapter

added in version 1.0.0
public SparseArrayObjectAdapter ()

Constructs an adapter.

Public methods

clear

added in version 1.0.0
public void clear (int key)

Clears the given key and associated item from the adapter.

Parameters
key int: The key to be cleared.

clear

added in version 1.0.0
public void clear ()

Removes all items from this adapter, leaving it empty.

get

added in version 1.0.0
public Object get (int position)

Returns the item for the given position.

Parameters
position int

Returns
Object

indexOf

added in version 1.0.0
public int indexOf (Object item)

Returns the index for the given item in the adapter.

Parameters
item Object: The item to find in the array.

Returns
int Index of the item, or a negative value if not found.

indexOf

added in version 1.0.0
public int indexOf (int key)

Returns the index for the given key in the adapter.

Parameters
key int: The key to find in the array.

Returns
int Index of the item, or a negative value if not found.

isImmediateNotifySupported

added in version 1.0.0
public boolean isImmediateNotifySupported ()

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

Returns
boolean

lookup

added in version 1.0.0
public Object lookup (int key)

Returns the object for the given key, or null if no mapping for that key exists.

Parameters
key int

Returns
Object

notifyArrayItemRangeChanged

added in version 1.0.0
public void notifyArrayItemRangeChanged (int positionStart, 
                int itemCount)

Notify that the content of a range of items changed. Note that this is not same as items being added or removed.

Parameters
positionStart int: The position of first item that has changed.

itemCount int: The count of how many items have changed.

set

added in version 1.0.0
public void set (int key, 
                Object item)

Sets the item for the given key.

Parameters
key int: The key associated with the item.

item Object: The item associated with the key.

size

added in version 1.0.0
public int size ()

Returns the number of items in the adapter.

Returns
int