com.communote.common.util

Class AugmentedPageableList<E>

java.lang.Object

com.communote.common.util.PageableList<E>

com.communote.common.util.AugmentedPageableList<E>

Type Parameters:

E - The type of the list

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>

public class AugmentedPageableList<E>
extends PageableList<E>

A PageableList that can be augmented with additional data.

Author:

Communote GmbH - http://www.communote.com/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AugmentedPageableList.AugmentationKeys This enum provides the available augmentation keys which are used to reference augmentation data.

Constructor Summary

Constructors

Constructor and Description
AugmentedPageableList(List<E> myList) Creates the augmented pageable list with the given list as back-end.

Method Summary

Modifier and Type	Method and Description
protected <T> PageableList<T>	createEmptyList(Class<T> typeClass) create a new empty list of the same type
<T> PageableList<T>	createEmptyListWithMetaData(Class<T> typeClass)
Object	getAugmentation(AugmentedPageableList.AugmentationKeys key) Returns augmentation data for the given key.
void	setAugmentation(AugmentedPageableList.AugmentationKeys key, Object value) Sets the augmentation data for the given key.

Methods inherited from class com.communote.common.util.PageableList

add, add, addAll, addAll, clear, contains, containsAll, emptyList, get, getMinNumberOfAdditionalElements, getMinNumberOfElements, getOffset, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, setMinNumberOfElements, setOffset, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AugmentedPageableList

public AugmentedPageableList(List<E> myList)

Creates the augmented pageable list with the given list as back-end.

Parameters:

myList - the list to wrap

Method Detail

createEmptyList

protected <T> PageableList<T> createEmptyList(Class<T> typeClass)

create a new empty list of the same type

Overrides:

createEmptyList in class PageableList<E>

Type Parameters:

T - type of the resulting class

Parameters:

typeClass - the class of the resulting class

Returns:

an empty list of the same type

createEmptyListWithMetaData

public <T> PageableList<T> createEmptyListWithMetaData(Class<T> typeClass)

Overrides:

createEmptyListWithMetaData in class PageableList<E>

Type Parameters:

T - type of the resulting class

Parameters:

typeClass - the class of the resulting class

Returns:

list with the meta data set as this

getAugmentation

public Object getAugmentation(AugmentedPageableList.AugmentationKeys key)

Returns augmentation data for the given key.

Parameters:

key - key identifying the requested data

Returns:

augmentation data

setAugmentation

public void setAugmentation(AugmentedPageableList.AugmentationKeys key,
                            Object value)

Sets the augmentation data for the given key.

Parameters:

key - key identifying the augmentation data to be set

value - the augmentation data