com.globusltd.recyclerview.datasource

Class ListDatasource<E>

java.lang.Object

com.globusltd.recyclerview.datasource.ListDatasource<E>

All Implemented Interfaces:

Datasource<E>

@MainThread
public class ListDatasource<E>
extends Object
implements Datasource<E>

Datasource implementation that uses ArrayList of the elements as the underlying data storage.

Constructor Summary

Constructors

Constructor and Description
ListDatasource()
ListDatasource(List<? extends E> items)

Method Summary

Modifier and Type	Method and Description
void	add(E e) Adds a data entity to the end.
void	add(int position, E e) Adds a data entity to a given position.
void	addAll(int position, List<? extends E> items) Adds all data entities after the specified position.
void	addAll(List<? extends E> items) Adds all data entities to the end.
void	clear() Removes all of the elements from this datastore.
E	get(int position) Returns the element at the specified position.
void	move(int fromPosition, int toPosition) Moves entity from one position to another.
void	registerDatasourceObserver(DatasourceObserver observer) Register a new observer to listen for data changes.
E	remove(int position) Removes entity at a given position.
void	removeRange(int fromPosition, int itemCount) Removes a range of elements.
E	set(int position, E item) Replaces the element at the specified position in this list with the specified element.
int	size() Returns the number of elements in this datastore.
void	unregisterDatasourceObserver(DatasourceObserver observer) Unregister an observer currently listening for data changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListDatasource

public ListDatasource()

ListDatasource

public ListDatasource(@NonNull
                      List<? extends E> items)

Method Detail

get

@NonNull
public E get(int position)

Returns the element at the specified position.

Specified by:

get in interface Datasource<E>

Parameters:

position - position of the element to return.

Returns:

the element at the specified position.

add

public void add(@NonNull
                E e)

Adds a data entity to the end.

Parameters:

e - a data entity

add

public void add(int position,
                @NonNull
                E e)

Adds a data entity to a given position.

Parameters:

position - an index in the data set.

e - a data entity.

addAll

public void addAll(@NonNull
                   List<? extends E> items)

Adds all data entities to the end.

Parameters:

items - a non-null List of data entities.

addAll

public void addAll(int position,
                   @NonNull
                   List<? extends E> items)

Adds all data entities after the specified position.

Parameters:

position - position at which to insert the first element from the specified collection.

items - a non-null List of data entities.

move

public void move(int fromPosition,
                 int toPosition)

Moves entity from one position to another.

Parameters:

fromPosition - an initial index.

toPosition - a new index.

set

@NonNull
public E set(int position,
                       @NonNull
                       E item)

Replaces the element at the specified position in this list with the specified element.

Parameters:

position - index of the element to replace.

item - element to be stored at the specified position.

Returns:

the element previously at the specified position.

remove

@NonNull
public E remove(int position)

Removes entity at a given position.

Parameters:

position - an index in the list of entities.

Returns:

removed entity.

removeRange

public void removeRange(int fromPosition,
                        int itemCount)

Removes a range of elements.

Parameters:

fromPosition - Position of the first item that be removed.

itemCount - Number of items removed from the data set.

clear

public void clear()

Removes all of the elements from this datastore. The datastore will be empty after this call returns.

size

public int size()

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

Specified by:

size in interface Datasource<E>

Returns:

The number of elements in this datastore.

registerDatasourceObserver

public 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.

Specified by:

registerDatasourceObserver in interface Datasource<E>

Parameters:

observer - Observer to register.

See Also:

Datasource.unregisterDatasourceObserver(DatasourceObserver)

unregisterDatasourceObserver

public 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.

Specified by:

unregisterDatasourceObserver in interface Datasource<E>

Parameters:

observer - Observer to unregister.

See Also:

Datasource.registerDatasourceObserver(DatasourceObserver)