PagedList (sdsai-dsds-core 0.0.5 API)

java.lang.Object
- com.github.basking2.sdsai.dsds.PagedList<STOREKEY,V>

All Implemented Interfaces:

java.lang.Iterable<V>, java.util.Collection<V>, java.util.List<V>
```
public class PagedList<STOREKEY,V>
extends java.lang.Object
implements java.util.List<V>
```
A circularly linked list in which each list element many data elements. This list does very well for in-order aggregation but quickly fragments if elements are inserted at arbitrary indexes.

Constructor Summary

Constructors
Constructor and Description
`PagedList(STOREKEY headKey, NodeStore<STOREKEY,STOREKEY,V> nodeStore)`
`PagedList(STOREKEY headKey, NodeStore<STOREKEY,STOREKEY,V> nodeStore, int pageSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, V value)`
`boolean`	`add(V value)`
`boolean`	`addAll(java.util.Collection<? extends V> c)`
`boolean`	`addAll(int index, java.util.Collection<? extends V> c)`
`void`	`clear()`
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection<?> c)`
`void`	`destroy()` Clear this list with `clear()` and then delete the empty head node.
`void`	`eachPage(NodeFunction<STOREKEY,STOREKEY> nodeFunction)`
`void`	`eachPage(NodeFunction<STOREKEY,STOREKEY> nodeFunction, STOREKEY startKey)`
`boolean`	`equals(java.lang.Object o)`
`V`	`get(int index)`
`int`	`indexOf(java.lang.Object o)`
`boolean`	`isEmpty()`
`java.util.Iterator<V>`	`iterator()`
`int`	`lastIndexOf(java.lang.Object o)`
`java.util.ListIterator<V>`	`listIterator()`
`java.util.ListIterator<V>`	`listIterator(int index)`
`java.util.Iterator<Node<STOREKEY,STOREKEY>>`	`pageIterator()`
`V`	`remove(int index)`
`boolean`	`remove(java.lang.Object o)`
`boolean`	`removeAll(java.util.Collection<?> c)`
`boolean`	`retainAll(java.util.Collection<?> c)`
`java.util.Iterator<Node<STOREKEY,STOREKEY>>`	`reversePageIterator()`
`V`	`set(int index, V value)`
`int`	`size()`
`java.util.List<V>`	`subList(int fromIndex, int toIndex)`
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] t)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List
hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - PagedList
```
public PagedList(STOREKEY headKey,
                 NodeStore<STOREKEY,STOREKEY,V> nodeStore,
                 int pageSize)
```
  - PagedList
```
public PagedList(STOREKEY headKey,
                 NodeStore<STOREKEY,STOREKEY,V> nodeStore)
```
- Method Detail
  - eachPage
```
public void eachPage(NodeFunction<STOREKEY,STOREKEY> nodeFunction)
```
  - eachPage
```
public void eachPage(NodeFunction<STOREKEY,STOREKEY> nodeFunction,
                     STOREKEY startKey)
```
  - reversePageIterator
```
public java.util.Iterator<Node<STOREKEY,STOREKEY>> reversePageIterator()
```
  - pageIterator
```
public java.util.Iterator<Node<STOREKEY,STOREKEY>> pageIterator()
```
  - add
```
public boolean add(V value)
```
    Specified by:
    
    add in interface java.util.Collection<V>
    
    Specified by:
    
    add in interface java.util.List<V>
  - add
```
public void add(int index,
                V value)
```
    Specified by:
    
    add in interface java.util.List<V>
  - addAll
```
public boolean addAll(java.util.Collection<? extends V> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<V>
    
    Specified by:
    
    addAll in interface java.util.List<V>
  - addAll
```
public boolean addAll(int index,
                      java.util.Collection<? extends V> c)
```
    Specified by:
    
    addAll in interface java.util.List<V>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<V>
    
    Specified by:
    
    clear in interface java.util.List<V>
  - destroy
```
public void destroy()
```
    Clear this list with clear() and then delete the empty head node.
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection<V>
    
    Specified by:
    
    contains in interface java.util.List<V>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<V>
    
    Specified by:
    
    containsAll in interface java.util.List<V>
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Collection<V>
    
    Specified by:
    
    equals in interface java.util.List<V>
    
    Overrides:
    
    equals in class java.lang.Object
  - get
```
public V get(int index)
```
    Specified by:
    
    get in interface java.util.List<V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<V>
    
    Specified by:
    
    isEmpty in interface java.util.List<V>
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    Specified by:
    
    indexOf in interface java.util.List<V>
  - iterator
```
public java.util.Iterator<V> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<V>
    
    Specified by:
    
    iterator in interface java.util.Collection<V>
    
    Specified by:
    
    iterator in interface java.util.List<V>
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    Specified by:
    
    lastIndexOf in interface java.util.List<V>
  - listIterator
```
public java.util.ListIterator<V> listIterator()
```
    Specified by:
    
    listIterator in interface java.util.List<V>
  - listIterator
```
public java.util.ListIterator<V> listIterator(int index)
```
    Specified by:
    
    listIterator in interface java.util.List<V>
  - remove
```
public V remove(int index)
```
    Specified by:
    
    remove in interface java.util.List<V>
  - remove
```
public boolean remove(java.lang.Object o)
```
    Specified by:
    
    remove in interface java.util.Collection<V>
    
    Specified by:
    
    remove in interface java.util.List<V>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<V>
    
    Specified by:
    
    removeAll in interface java.util.List<V>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<V>
    
    Specified by:
    
    retainAll in interface java.util.List<V>
  - set
```
public V set(int index,
             V value)
```
    Specified by:
    
    set in interface java.util.List<V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<V>
    
    Specified by:
    
    size in interface java.util.List<V>
  - subList
```
public java.util.List<V> subList(int fromIndex,
                                 int toIndex)
```
    Specified by:
    
    subList in interface java.util.List<V>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<V>
    
    Specified by:
    
    toArray in interface java.util.List<V>
  - toArray
```
public <T> T[] toArray(T[] t)
```
    Specified by:
    
    toArray in interface java.util.Collection<V>
    
    Specified by:
    
    toArray in interface java.util.List<V>

Class PagedList<STOREKEY,V>

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

PagedList

PagedList

Method Detail

eachPage

eachPage

reversePageIterator

pageIterator

add

add

addAll

addAll

clear

destroy

contains

containsAll

equals

get

isEmpty

indexOf

iterator

lastIndexOf

listIterator

listIterator

remove

remove

removeAll

retainAll

set

size

subList

toArray

toArray