com.globusltd.recyclerview.datasource

Class DatasourceProxy<E>

java.lang.Object

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

All Implemented Interfaces:

Datasource<E>, DatasourceSwappable<E>, Swappable<Datasource<? extends E>>

@MainThread
public class DatasourceProxy<E>
extends Object
implements Datasource<E>, DatasourceSwappable<E>

Constructor Summary

Constructors

Constructor and Description
DatasourceProxy(Datasource<? extends E> datasource, DiffCallbackFactory<E> diffCallbackFactory)

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.
Datasource<? extends E>	swap(Datasource<? extends E> datasource) Performs swapping the internal components and returns the previous component.
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

DatasourceProxy

public DatasourceProxy(@NonNull
                       Datasource<? extends E> datasource,
                       @Nullable
                       DiffCallbackFactory<E> diffCallbackFactory)

Method Detail

swap

@Nullable
public Datasource<? extends E> swap(@NonNull
                                               Datasource<? extends E> datasource)

Description copied from interface: Swappable

Performs swapping the internal components and returns the previous component.

Specified by:

swap in interface Swappable<Datasource<? extends E>>

Parameters:

datasource - The new component that should replace the old one.

Returns:

The previous component.

get

@NonNull
public E get(int position)

Description copied from interface: Datasource

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.

size

public int size()

Description copied from interface: Datasource

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)

Description copied from interface: Datasource

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)

Description copied from interface: Datasource

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)