universum.studios.android.widget.adapter

Interface DataSet<Item>

Type Parameters:

Item - Item model that represents data structure of the data provided by this data set.

All Known Subinterfaces:

DataSetAdapter<Item>, ItemsAdapter<Item>

All Known Implementing Classes:

BaseAdapter, BaseRecyclerAdapter, BaseSpinnerAdapter, SimpleAdapter, SimpleRecyclerAdapter, SimpleSpinnerAdapter

public interface DataSet<Item>

Interface specifying API for data sets that contain a simple set of items.

Author:

Martin Albedinsky

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_ID Constant that identifies invalid/unspecified id.
static int	NO_POSITION Constant that identifies invalid/unspecified position.

Method Summary

Modifier and Type	Method and Description
Item	getItem(int position) Returns the item (model) containing data from this data set for the specified position.
int	getItemCount() Returns the count of items available within this data set.
long	getItemId(int position) Returns the ID of the item at the specified position.
boolean	hasItemAt(int position) Returns a boolean flag indicating whether this data set has item that can provide data for the specified position or not.
boolean	isEmpty() Returns a boolean flag indicating whether this data set is empty or not.
void	registerOnDataChangeListener(OnDataChangeListener listener) Registers a callback to be invoked when a data change occurs in this data set.
void	registerOnDataSetActionListener(OnDataSetActionListener listener) Registers a callback to be invoked when a specific data set action is selected within this data set.
void	registerOnDataSetListener(OnDataSetListener listener) Registers a callback to be invoked when a data set event occurs.
void	unregisterOnDataChangeListener(OnDataChangeListener listener) Unregisters the given callback from the data change listeners, so it will not receive any callbacks further.
void	unregisterOnDataSetActionListener(OnDataSetActionListener listener) Unregisters the given callback from the data set action listeners, so it will not receive any callbacks further.
void	unregisterOnDataSetListener(OnDataSetListener listener) Unregisters the given callback from the data set listeners, so it will not receive any callbacks further.

Field Detail

NO_POSITION

static final int NO_POSITION

Constant that identifies invalid/unspecified position.

See Also:

Constant Field Values

NO_ID

static final long NO_ID

Constant that identifies invalid/unspecified id.

See Also:

Constant Field Values

Method Detail

registerOnDataChangeListener

void registerOnDataChangeListener(@NonNull
                                  OnDataChangeListener listener)

Registers a callback to be invoked when a data change occurs in this data set.

Parameters:

listener - The desired listener callback to register.

See Also:

unregisterOnDataChangeListener(OnDataChangeListener)

unregisterOnDataChangeListener

void unregisterOnDataChangeListener(@NonNull
                                    OnDataChangeListener listener)

Unregisters the given callback from the data change listeners, so it will not receive any callbacks further.

Parameters:

listener - The desired listener callback to unregister.

See Also:

registerOnDataChangeListener(OnDataChangeListener)

registerOnDataSetListener

void registerOnDataSetListener(@NonNull
                               OnDataSetListener listener)

Registers a callback to be invoked when a data set event occurs. The occurred event may be a local change in the data set, or an invalidation of the data set.

Parameters:

listener - The desired listener callback to register.

See Also:

unregisterOnDataSetListener(OnDataSetListener)

unregisterOnDataSetListener

void unregisterOnDataSetListener(@NonNull
                                 OnDataSetListener listener)

Unregisters the given callback from the data set listeners, so it will not receive any callbacks further.

Parameters:

listener - The desired listener callback to unregister.

See Also:

registerOnDataSetListener(OnDataSetListener)

registerOnDataSetActionListener

void registerOnDataSetActionListener(@NonNull
                                     OnDataSetActionListener listener)

Registers a callback to be invoked when a specific data set action is selected within this data set.

Parameters:

listener - The desired listener callback to register.

See Also:

unregisterOnDataSetActionListener(OnDataSetActionListener)

unregisterOnDataSetActionListener

void unregisterOnDataSetActionListener(@NonNull
                                       OnDataSetActionListener listener)

Unregisters the given callback from the data set action listeners, so it will not receive any callbacks further.

Parameters:

listener - The desired listener callback to unregister.

See Also:

registerOnDataSetActionListener(OnDataSetActionListener)

isEmpty

boolean isEmpty()

Returns a boolean flag indicating whether this data set is empty or not.

Returns:

True if cursor attached to this data set has no rows or it is null, false otherwise.

See Also:

getItemCount()

getItemCount

int getItemCount()

Returns the count of items available within this data set.

Returns:

Count of rows of the attached cursor or 0 if no cursor is attached or it has no rows.

See Also:

isEmpty(), hasItemAt(int), getItem(int)

hasItemAt

boolean hasItemAt(int position)

Returns a boolean flag indicating whether this data set has item that can provide data for the specified position or not.

Parameters:

position - The position of item to check.

Returns:

True if getItem(int) can be called 'safely', false otherwise.

getItem

@NonNull
Item getItem(int position)

Returns the item (model) containing data from this data set for the specified position.

Parameters:

position - Position of the item to obtain.

Returns:

Item with data for the requested position.

Throws:

IndexOutOfBoundsException - If the specified position is out of bounds of the current data set.

See Also:

hasItemAt(int), getItemId(int)

getItemId

long getItemId(int position)

Returns the ID of the item at the specified position.

Parameters:

position - The position of item of which id to obtain.

Returns:

Item's id or NO_ID if there is no item at the specified position.

See Also:

hasItemAt(int), getItem(int)