com.globusltd.recyclerview.datasource

Interface Datasource<E>

Type Parameters:

E - Type of elements handled by datastore.

All Known Implementing Classes:

CursorDatasource, DatasourceProxy, ListDatasource

@MainThread
public interface Datasource<E>

Datasource is an abstraction over elements storage.

Method Summary

Modifier and Type	Method and Description
E	get(int position) Returns the element at the specified position.
void	registerDatasourceObserver(DatasourceObserver observer) Register a new observer to listen for data changes.
int	size() Returns the number of elements in this datastore.
void	unregisterDatasourceObserver(DatasourceObserver observer) Unregister an observer currently listening for data changes.

Method Detail

get

@NonNull
E get(int position)

Returns the element at the specified position.

Parameters:

position - position of the element to return.

Returns:

the element at the specified position.

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

size

int size()

Returns the number of elements in this datastore. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

The number of elements in this datastore.

registerDatasourceObserver

void registerDatasourceObserver(@NonNull
                                DatasourceObserver observer)

Register a new observer to listen for data changes.

The datasource may publish a variety of events describing specific changes. Not all datasource may support all change types and some may fall back to a generic DatasourceObserver.onChanged() "something changed" event if more specific data is not available.

Components registering observers with a datasource are responsible for unregistering those observers when finished.

Parameters:

observer - Observer to register.

See Also:

unregisterDatasourceObserver(DatasourceObserver)

unregisterDatasourceObserver

void unregisterDatasourceObserver(@NonNull
                                  DatasourceObserver observer)

Unregister an observer currently listening for data changes.

The unregistered observer will no longer receive events about changes to the datasource.

Parameters:

observer - Observer to unregister.

See Also:

registerDatasourceObserver(DatasourceObserver)