PageableList (Communote 3.5 API)

java.lang.Object
- com.communote.common.util.PageableList<E>

Type Parameters:

E - The type of the list

All Implemented Interfaces:

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

Direct Known Subclasses:

AugmentedPageableList
```
public class PageableList<E>
extends Object
implements List<E>
```
A list wrapper with additional attributes which state whether there are more elements if the list represents subset of a larger data-set. This is for instance useful if the list holds only a range of the results of a database query.

Author:

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

Constructor Summary

Constructors
Constructor and Description

PageableList(Collection<E> myCollection)
Create a list wrapping the given list

PageableList(List<E> myList)
Create a list wrapping the given list

Constructors
Constructor and Description
`PageableList(Collection<E> myCollection)` Create a list wrapping the given list
`PageableList(List<E> myList)` Create a list wrapping the given list

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E e)`
`void`	`add(int index, E element)`
`boolean`	`addAll(Collection<? extends E> c)`
`boolean`	`addAll(int index, Collection<? extends E> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`protected <T> PageableList<T>`	`createEmptyList(Class<T> typeClass)` create a new empty list of the same type
`<T> PageableList<T>`	`createEmptyListWithMetaData(Class<T> typeClass)`
`static <T> PageableList<T>`	`emptyList()` Get an empty, unmodifiable empty list
`E`	`get(int index)`
`int`	`getMinNumberOfAdditionalElements()`
`int`	`getMinNumberOfElements()`
`int`	`getOffset()`
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`Iterator<E>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<E>`	`listIterator()`
`ListIterator<E>`	`listIterator(int index)`
`E`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`E`	`set(int index, E element)`
`void`	`setMinNumberOfElements(int minNumberOfElements)`
`void`	`setOffset(int offset)`
`int`	`size()`
`List<E>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] 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.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
  - PageableList
```
public PageableList(Collection<E> myCollection)
```
    Create a list wrapping the given list
    
    Parameters:
    
    myCollection - the actual list to wrap
  - PageableList
```
public PageableList(List<E> myList)
```
    Create a list wrapping the given list
    
    Parameters:
    
    myList - the actual list to wrap
- Method Detail
  - emptyList
```
public static <T> PageableList<T> emptyList()
```
    Get an empty, unmodifiable empty list
    
    Type Parameters:
    
    T - the type (does not matter since list is empty)
    
    Returns:
    
    the empty list
  - add
```
public boolean add(E e)
```
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface List<E>
  - add
```
public void add(int index,
                E element)
```
    Specified by:
    
    add in interface List<E>
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface List<E>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface List<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface List<E>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface List<E>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface List<E>
  - createEmptyList
```
protected <T> PageableList<T> createEmptyList(Class<T> typeClass)
```
    create a new empty list of the same type
    
    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)
```
    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
  - get
```
public E get(int index)
```
    Specified by:
    
    get in interface List<E>
  - getMinNumberOfAdditionalElements
```
public int getMinNumberOfAdditionalElements()
```
    Returns:
    
    the number of additional elements which are at least contained in the full result. This number is the difference of getMinNumberOfElements(), the actual size of this result range (size()) and of course the offset of the range ( getOffset()).
  - getMinNumberOfElements
```
public int getMinNumberOfElements()
```
    Returns:
    
    the number of elements which are at least contained in the full result.
    
    See Also:
    
    setMinNumberOfElements(int)
  - getOffset
```
public int getOffset()
```
    Returns:
    
    the offset of this result set range within all results
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface List<E>
  - iterator
```
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface List<E>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator()
```
    Specified by:
    
    listIterator in interface List<E>
  - listIterator
```
public ListIterator<E> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<E>
  - remove
```
public E remove(int index)
```
    Specified by:
    
    remove in interface List<E>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface List<E>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface List<E>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface List<E>
  - set
```
public E set(int index,
             E element)
```
    Specified by:
    
    set in interface List<E>
  - setMinNumberOfElements
```
public void setMinNumberOfElements(int minNumberOfElements)
```
    Parameters:
    
    minNumberOfElements - the number of elements which are at least contained in the full result. This does not have to be the overall size. So for instance when doing a query one can define to retrieve only the first n matches but also to check if there are m additional hits. When the query completes you would add the n matches to the list and set this value to n + the actual number of additional results found. This number could be m or a smaller value. In the latter case minNumberOfElements would hold the overall size.
  - setOffset
```
public void setOffset(int offset)
```
    Parameters:
    
    offset - the offset to set
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface List<E>
  - subList
```
public List<E> subList(int fromIndex,
                       int toIndex)
```
    Specified by:
    
    subList in interface List<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface List<E>

Class PageableList<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

PageableList

PageableList

Method Detail

emptyList

add

add

addAll

addAll

clear

contains

containsAll

createEmptyList

createEmptyListWithMetaData

get

getMinNumberOfAdditionalElements

getMinNumberOfElements

getOffset

indexOf

isEmpty

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

setMinNumberOfElements

setOffset

size

subList

toArray

toArray