Package com.storedobject.core

Class ObjectCacheList<T extends StoredObject>

java.lang.Object

com.storedobject.core.ObjectCacheList<T>

All Implemented Interfaces:

Filtered<T>, FilterMethods<T>, ObjectList<T>, ObjectLoader<T>, AutoCloseable, Iterable<T>, Collection<T>, List<T>, SequencedCollection<T>

public class ObjectCacheList<T extends StoredObject>
extends Object
implements ObjectList<T>, AutoCloseable

Constructor Summary

Constructors

Constructor	Description
ObjectCacheList(Class<T> objectClass)
ObjectCacheList(Class<T> objectClass, boolean any)
ObjectCacheList(Class<T> objectClass, ObjectIterator<T> objects)
ObjectCacheList(Class<T> objectClass, Query query)
ObjectCacheList(Class<T> objectClass, Query query, boolean any)
ObjectCacheList(Class<T> objectClass, Iterable<Id> idList)
ObjectCacheList(Class<T> objectClass, String condition)
ObjectCacheList(Class<T> objectClass, String condition, boolean any)
ObjectCacheList(Class<T> objectClass, String condition, String orderedBy)
ObjectCacheList(Class<T> objectClass, String condition, String orderedBy, boolean any)
ObjectCacheList(Class<T> objectClass, Stream<T> objects)

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
boolean	add(Id id)
boolean	add(T object)
boolean	addAll(int index, Collection<? extends T> collection)
boolean	addAll(Collection<? extends T> collection)
void	applyFilterPredicate()	This method is called whenever a filter predicate is changed.
void	clear()	Clear - remove all entries.
void	close()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
void	filter(Predicate<? super T> filter)
void	filter(Predicate<? super T> filter, Comparator<? super T> comparator)
T	get(int index)
int	getCacheLevel()
final Comparator<? super T>	getComparator()
final Predicate<? super T>	getFilter()
ObjectLoadFilter<T>	getLoadFilter()	Get the load filter.
Class<T>	getObjectClass()	The class of the instances.
Stream<Id>	idStream(int startingIndex, int endingIndex)
Stream<Id>	idStreamAll(int startingIndex, int endingIndex)
int	indexOf(Id id)
int	indexOf(Object o)
boolean	isAllowAny()	Retrieve sub-classes?
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
void	load(ObjectIterator<T> objects)	Load the given instances.
void	load(Query query, boolean any)	Load the instances created from the query.
void	load(Iterable<Id> idList)	Load the instances created from the list of Ids.
void	load(String condition, String orderedBy, boolean any)	Load the instances.
void	load(Stream<T> objects)	Load the given instances.
void	order(Comparator<? super T> comparator)
void	refresh()
T	refresh(Id id)
T	refresh(T object)
T	remove(int index)
boolean	remove(Object object)
boolean	removeAll(Collection<?> collection)
boolean	removeIf(Predicate<? super T> filter)
boolean	retainAll(Collection<?> collection)
T	set(int index, T element)
void	setLoadFilter(Predicate<T> loadFilter)	Set the load filter.
void	setProcessor(Consumer<T> processor)
int	size()	Get the instances count.
int	size(int startingIndex, int endingIndex)
int	sizeAll()
void	sort(Comparator<? super T> comparator)
Stream<T>	stream(int startingIndex, int endingIndex)
Stream<T>	streamAll(int startingIndex, int endingIndex)
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<O> O[]	toArray(O[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface com.storedobject.core.FilterMethods

getEffectiveCondition, getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, spliterator

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, getAllowAny, getLinkType, getMaster, getOrderBy, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Constructor Details

ObjectCacheList

public ObjectCacheList(Class<T> objectClass)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 boolean any)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 String condition)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 String condition,
 boolean any)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 String condition,
 String orderedBy)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 String condition,
 String orderedBy,
 boolean any)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 Query query)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 Query query,
 boolean any)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 Iterable<Id> idList)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 ObjectIterator<T> objects)

ObjectCacheList

public ObjectCacheList(Class<T> objectClass,
 Stream<T> objects)

Method Details

setLoadFilter

public void setLoadFilter(Predicate<T> loadFilter)

Description copied from interface: FilterMethods

Set the load filter. This will be applied whenever loading takes place.

Specified by:

setLoadFilter in interface FilterMethods<T extends StoredObject>

Parameters:

loadFilter - Load filter to be applied while loading.

applyFilterPredicate

public void applyFilterPredicate()

Description copied from interface: FilterMethods

This method is called whenever a filter predicate is changed. Methods with default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Note: This method is used to show the filtered result of the existing entries

Specified by:

applyFilterPredicate in interface FilterMethods<T extends StoredObject>

getLoadFilter

@Nonnull
public ObjectLoadFilter<T> getLoadFilter()

Description copied from interface: FilterMethods

Get the load filter.

Specified by:

getLoadFilter in interface FilterMethods<T extends StoredObject>

Returns:

Current load filter.

load

public void load(String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the instances. Current "load filter" if set will be applied. If "master" is already set, "links" of the "master" will be loaded.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(Query query,
 boolean any)

Description copied from interface: ObjectLoader

Load the instances created from the query. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

query - Query from which objects to be loaded.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(Iterable<Id> idList)

Description copied from interface: ObjectLoader

Load the instances created from the list of Ids. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

idList - List of Ids from which objects to be loaded.

load

public void load(ObjectIterator<T> objects)

Description copied from interface: ObjectLoader

Load the given instances. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

objects - Objects to be loaded.

load

public void load(Stream<T> objects)

Description copied from interface: ObjectLoader

Load the given instances. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

objects - Objects to be loaded.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ObjectList<T extends StoredObject>

isAllowAny

public boolean isAllowAny()

Description copied from interface: ObjectLoader

Retrieve sub-classes?

Specified by:

isAllowAny in interface ObjectLoader<T extends StoredObject>

Returns:

Whether instanced of the subclasses to be retrieved or not.

getObjectClass

public Class<T> getObjectClass()

Description copied from interface: ObjectLoader

The class of the instances.

Specified by:

getObjectClass in interface ObjectLoader<T extends StoredObject>

Returns:

The class of the instances to load.

size

public int size()

Description copied from interface: ObjectLoader

Get the instances count.

Specified by:

size in interface Collection<T extends StoredObject>

Specified by:

size in interface Filtered<T extends StoredObject>

Specified by:

size in interface List<T extends StoredObject>

Specified by:

size in interface ObjectLoader<T extends StoredObject>

Returns:

Count.

size

public int size(int startingIndex,
 int endingIndex)

Specified by:

size in interface Filtered<T extends StoredObject>

sizeAll

public int sizeAll()

Specified by:

sizeAll in interface Filtered<T extends StoredObject>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T extends StoredObject>

Specified by:

isEmpty in interface List<T extends StoredObject>

Specified by:

isEmpty in interface ObjectList<T extends StoredObject>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T extends StoredObject>

Specified by:

contains in interface List<T extends StoredObject>

iterator

@Nonnull
public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T extends StoredObject>

Specified by:

iterator in interface Iterable<T extends StoredObject>

Specified by:

iterator in interface List<T extends StoredObject>

toArray

@Nonnull
public Object[] toArray()

Specified by:

toArray in interface Collection<T extends StoredObject>

Specified by:

toArray in interface List<T extends StoredObject>

toArray

@Nonnull
public <O> O[] toArray(@Nonnull
 O[] a)

Specified by:

toArray in interface Collection<T extends StoredObject>

Specified by:

toArray in interface List<T extends StoredObject>

add

public boolean add(T object)

Specified by:

add in interface Collection<T extends StoredObject>

Specified by:

add in interface List<T extends StoredObject>

add

public boolean add(Id id)

Specified by:

add in interface ObjectList<T extends StoredObject>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<T extends StoredObject>

Specified by:

remove in interface List<T extends StoredObject>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T extends StoredObject>

Specified by:

containsAll in interface List<T extends StoredObject>

addAll

public boolean addAll(@Nonnull
 Collection<? extends T> collection)

Specified by:

addAll in interface Collection<T extends StoredObject>

Specified by:

addAll in interface List<T extends StoredObject>

addAll

public boolean addAll(int index,
 @Nonnull
 Collection<? extends T> collection)

Specified by:

addAll in interface List<T extends StoredObject>

removeAll

public boolean removeAll(@Nonnull
 Collection<?> collection)

Specified by:

removeAll in interface Collection<T extends StoredObject>

Specified by:

removeAll in interface List<T extends StoredObject>

removeIf

public boolean removeIf(Predicate<? super T> filter)

Specified by:

removeIf in interface Collection<T extends StoredObject>

retainAll

public boolean retainAll(@Nonnull
 Collection<?> collection)

Specified by:

retainAll in interface Collection<T extends StoredObject>

Specified by:

retainAll in interface List<T extends StoredObject>

clear

public void clear()

Description copied from interface: ObjectLoader

Clear - remove all entries.

Specified by:

clear in interface Collection<T extends StoredObject>

Specified by:

clear in interface List<T extends StoredObject>

Specified by:

clear in interface ObjectList<T extends StoredObject>

Specified by:

clear in interface ObjectLoader<T extends StoredObject>

get

public T get(int index)

Specified by:

get in interface List<T extends StoredObject>

set

public T set(int index,
 T element)

Specified by:

set in interface List<T extends StoredObject>

add

public void add(int index,
 T element)

Specified by:

add in interface List<T extends StoredObject>

remove

public T remove(int index)

Specified by:

remove in interface List<T extends StoredObject>

indexOf

public int indexOf(Id id)

Specified by:

indexOf in interface ObjectList<T extends StoredObject>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T extends StoredObject>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T extends StoredObject>

listIterator

@Nonnull
public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T extends StoredObject>

listIterator

@Nonnull
public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T extends StoredObject>

subList

@Nonnull
public List<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T extends StoredObject>

refresh

public void refresh()

Specified by:

refresh in interface ObjectList<T extends StoredObject>

refresh

public T refresh(Id id)

Specified by:

refresh in interface ObjectList<T extends StoredObject>

refresh

public T refresh(T object)

Specified by:

refresh in interface ObjectList<T extends StoredObject>

sort

public void sort(Comparator<? super T> comparator)

Specified by:

sort in interface List<T extends StoredObject>

order

public void order(Comparator<? super T> comparator)

Specified by:

order in interface Filtered<T extends StoredObject>

filter

public void filter(Predicate<? super T> filter)

Specified by:

filter in interface Filtered<T extends StoredObject>

filter

public void filter(Predicate<? super T> filter,
 Comparator<? super T> comparator)

Specified by:

filter in interface Filtered<T extends StoredObject>

getFilter

public final Predicate<? super T> getFilter()

Specified by:

getFilter in interface Filtered<T extends StoredObject>

getComparator

public final Comparator<? super T> getComparator()

Specified by:

getComparator in interface Filtered<T extends StoredObject>

stream

public Stream<T> stream(int startingIndex,
 int endingIndex)

Specified by:

stream in interface Filtered<T extends StoredObject>

streamAll

public Stream<T> streamAll(int startingIndex,
 int endingIndex)

Specified by:

streamAll in interface Filtered<T extends StoredObject>

idStream

public Stream<Id> idStream(int startingIndex,
 int endingIndex)

Specified by:

idStream in interface ObjectList<T extends StoredObject>

idStreamAll

public Stream<Id> idStreamAll(int startingIndex,
 int endingIndex)

Specified by:

idStreamAll in interface ObjectList<T extends StoredObject>

getCacheLevel

public int getCacheLevel()

Specified by:

getCacheLevel in interface ObjectList<T extends StoredObject>

setProcessor

public void setProcessor(Consumer<T> processor)

Specified by:

setProcessor in interface ObjectList<T extends StoredObject>