io.rx_cache2

Class ActionsList<T>

java.lang.Object

io.rx_cache2.ActionsList<T>

public class ActionsList<T>
extends java.lang.Object

Provides a set of actions in order to perform write operations on lists with providers in a more easy and safely way.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ActionsList.Evict<T>
static interface	ActionsList.Func1Count
static interface	ActionsList.Func1Element<T>
static interface	ActionsList.Func2
static interface	ActionsList.Func3<T>
static interface	ActionsList.Replace<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected io.reactivex.Observable<java.util.List<T>>	cache
protected ActionsList.Evict<T>	evict

Constructor Summary

Constructors

Constructor and Description
ActionsList(ActionsList.Evict<T> evict, io.reactivex.Observable<java.util.List<T>> cache)

Method Summary

Modifier and Type	Method and Description
ActionsList<T>	add(ActionsList.Func2 func2, T element) Func2 will be called for every iteration until its condition returns true.
ActionsList<T>	addAll(ActionsList.Func2 func2, java.util.List<T> elements) Func2 will be called for every iteration until its condition returns true.
ActionsList<T>	addAllFirst(java.util.List<T> elements) Add the objects at the first position of the cache.
ActionsList<T>	addAllLast(java.util.List<T> elements) Add the objects at the last position of the cache.
ActionsList<T>	addFirst(T element) Add the object at the first position of the cache.
ActionsList<T>	addLast(T element) Add the object at the last position of the cache.
ActionsList<T>	evict(ActionsList.Func1Element<T> func1Element) Func1Element will be called for every iteration until its condition returns true.
ActionsList<T>	evict(ActionsList.Func3<T> func3) Func3 will be called for every iteration until its condition returns true.
ActionsList<T>	evictAll() Evict all elements from the cache
ActionsList<T>	evictAllKeepingFirstN(int n) Evict elements from the cache starting from the first position until its count is equal to the value specified in n param.
ActionsList<T>	evictAllKeepingLastN(int n) Evict elements from the cache starting from the last position until its count is equal to the value specified in n param.
ActionsList<T>	evictFirst() Evict object at the first position of the cache
ActionsList<T>	evictFirst(ActionsList.Func1Count func1Count) Evict object at the first position of the cache.
ActionsList<T>	evictFirstN(ActionsList.Func1Count func1Count, int n) Evict as much objects as requested by n param starting from the first position.
ActionsList<T>	evictFirstN(int n) Evict as much objects as requested by n param starting from the first position.
ActionsList<T>	evictIterable(ActionsList.Func3<T> func3) Func3 will be called for every iteration.
ActionsList<T>	evictLast() Evict object at the last position of the cache.
ActionsList<T>	evictLast(ActionsList.Func1Count func1Count) Evict object at the last position of the cache.
ActionsList<T>	evictLastN(ActionsList.Func1Count func1Count, int n) Evict as much objects as requested by n param starting from the last position.
ActionsList<T>	evictLastN(int n) Evict as much objects as requested by n param starting from the last position.
io.reactivex.Observable<java.util.List<T>>	toObservable()
ActionsList<T>	update(ActionsList.Func1Element<T> func1Element, ActionsList.Replace<T> replace) Func1Element will be called for every iteration until its condition returns true.
ActionsList<T>	update(ActionsList.Func3<T> func3, ActionsList.Replace<T> replace) Func3 will be called for every iteration until its condition returns true.
ActionsList<T>	updateIterable(ActionsList.Func1Element<T> func1Element, ActionsList.Replace<T> replace) Func1Element will be called for every.
ActionsList<T>	updateIterable(ActionsList.Func3<T> func3, ActionsList.Replace<T> replace) Func3 will be called for every iteration.
static <T> ActionsList<T>	with(ActionsList.Evict<T> evict, io.reactivex.Observable<java.util.List<T>> cache) Static accessor to create an instance of Actions in order follow the "builder" pattern.

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected io.reactivex.Observable<java.util.List<T>> cache

evict

protected final ActionsList.Evict<T> evict

Constructor Detail

ActionsList

public ActionsList(ActionsList.Evict<T> evict,
                   io.reactivex.Observable<java.util.List<T>> cache)

Method Detail

with

public static <T> ActionsList<T> with(ActionsList.Evict<T> evict,
                                      io.reactivex.Observable<java.util.List<T>> cache)

Static accessor to create an instance of Actions in order follow the "builder" pattern.

Type Parameters:

T - the type of the element of the list to be processed.

Parameters:

evict - The implementation of Evict interface which allow to persists the changes.

cache - An observable which is the result of calling the provider without evicting its data.

Returns:

an instance of Actions.

add

public ActionsList<T> add(ActionsList.Func2 func2,
                          T element)

Func2 will be called for every iteration until its condition returns true. When true, the element is added to the cache at the position of the current iteration.

Parameters:

func2 - exposes the position of the current iteration and the count of elements in the cache.

element - the object to addOrUpdate to the cache.

Returns:

itself

addFirst

public ActionsList<T> addFirst(T element)

Add the object at the first position of the cache.

Parameters:

element - the object to addOrUpdate to the cache.

Returns:

itself

addLast

public ActionsList<T> addLast(T element)

Add the object at the last position of the cache.

Parameters:

element - the object to addOrUpdate to the cache.

Returns:

itself

addAllFirst

public ActionsList<T> addAllFirst(java.util.List<T> elements)

Add the objects at the first position of the cache.

Parameters:

elements - the objects to addOrUpdate to the cache.

Returns:

itself

addAllLast

public ActionsList<T> addAllLast(java.util.List<T> elements)

Add the objects at the last position of the cache.

Parameters:

elements - the objects to addOrUpdate to the cache.

Returns:

itself

addAll

public ActionsList<T> addAll(ActionsList.Func2 func2,
                             java.util.List<T> elements)

Func2 will be called for every iteration until its condition returns true. When true, the elements are added to the cache at the position of the current iteration.

Parameters:

func2 - exposes the position of the current iteration and the count of elements in the cache.

elements - the objects to addOrUpdate to the cache.

Returns:

itself

evictFirst

public ActionsList<T> evictFirst()

Evict object at the first position of the cache

Returns:

itself

evictFirstN

public ActionsList<T> evictFirstN(int n)

Evict as much objects as requested by n param starting from the first position.

Parameters:

n - the amount of elements to evict.

Returns:

itself

evictLast

public ActionsList<T> evictLast()

Evict object at the last position of the cache.

Returns:

itself

evictLastN

public ActionsList<T> evictLastN(int n)

Evict as much objects as requested by n param starting from the last position.

Parameters:

n - the amount of elements to evict.

Returns:

itself

evictFirst

public ActionsList<T> evictFirst(ActionsList.Func1Count func1Count)

Evict object at the first position of the cache.

Parameters:

func1Count - exposes the count of elements in the cache.

Returns:

itself

evictFirstN

public ActionsList<T> evictFirstN(ActionsList.Func1Count func1Count,
                                  int n)

Evict as much objects as requested by n param starting from the first position.

Parameters:

func1Count - exposes the count of elements in the cache.

n - the amount of elements to evict.

Returns:

itself

evictLast

public ActionsList<T> evictLast(ActionsList.Func1Count func1Count)

Evict object at the last position of the cache.

Parameters:

func1Count - exposes the count of elements in the cache.

Returns:

itself

evictLastN

public ActionsList<T> evictLastN(ActionsList.Func1Count func1Count,
                                 int n)

Evict as much objects as requested by n param starting from the last position.

Parameters:

func1Count - exposes the count of elements in the cache.

n - the amount of elements to evict.

Returns:

itself

evict

public ActionsList<T> evict(ActionsList.Func1Element<T> func1Element)

Func1Element will be called for every iteration until its condition returns true. When true, the element of the current iteration is evicted from the cache.

Parameters:

func1Element - exposes the element of the current iteration.

Returns:

itself

evict

public ActionsList<T> evict(ActionsList.Func3<T> func3)

Func3 will be called for every iteration until its condition returns true. When true, the element of the current iteration is evicted from the cache.

Parameters:

func3 - exposes the position of the current iteration, the count of elements in the cache and the element of the current iteration.

Returns:

itself

evictAll

public ActionsList<T> evictAll()

Evict all elements from the cache

Returns:

itself

evictAllKeepingFirstN

public ActionsList<T> evictAllKeepingFirstN(int n)

Evict elements from the cache starting from the first position until its count is equal to the value specified in n param.

Parameters:

n - the amount of elements to keep from evict.

Returns:

itself

evictAllKeepingLastN

public ActionsList<T> evictAllKeepingLastN(int n)

Evict elements from the cache starting from the last position until its count is equal to the value specified in n param.

Parameters:

n - the amount of elements to keep from evict.

Returns:

itself

evictIterable

public ActionsList<T> evictIterable(ActionsList.Func3<T> func3)

Func3 will be called for every iteration. When true, the element of the current iteration is evicted from the cache.

Parameters:

func3 - exposes the position of the current iteration, the count of elements in the cache and the element of the current iteration.

Returns:

itself

update

public ActionsList<T> update(ActionsList.Func1Element<T> func1Element,
                             ActionsList.Replace<T> replace)

Func1Element will be called for every iteration until its condition returns true. When true, the element of the current iteration is updated.

Parameters:

func1Element - exposes the element of the current iteration.

replace - exposes the original element and expects back the one modified.

Returns:

itself

update

public ActionsList<T> update(ActionsList.Func3<T> func3,
                             ActionsList.Replace<T> replace)

Func3 will be called for every iteration until its condition returns true. When true, the element of the current iteration is updated.

Parameters:

func3 - exposes the position of the current iteration, the count of elements in the cache and the element of the current iteration.

replace - exposes the original element and expects back the one modified.

Returns:

itself

updateIterable

public ActionsList<T> updateIterable(ActionsList.Func1Element<T> func1Element,
                                     ActionsList.Replace<T> replace)

Func1Element will be called for every. When true, the element of the current iteration is updated.

Parameters:

func1Element - exposes the element of the current iteration.

replace - exposes the original element and expects back the one modified.

Returns:

itself

updateIterable

public ActionsList<T> updateIterable(ActionsList.Func3<T> func3,
                                     ActionsList.Replace<T> replace)

Func3 will be called for every iteration. When true, the element of the current iteration is updated.

Parameters:

func3 - exposes the position of the current iteration, the count of elements in the cache and the element of the current iteration.

replace - exposes the original element and expects back the one modified.

Returns:

itself

toObservable

public io.reactivex.Observable<java.util.List<T>> toObservable()