com.gooddata.collections

Class MultiPageList<T>

java.lang.Object

com.gooddata.collections.PageableList<T>

com.gooddata.collections.MultiPageList<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>

public class MultiPageList<T>
extends PageableList<T>

Adapter over PageableList to offer easy iteration/streaming over multiple pages, lazily loading of pages using specified pageProvider.

Constructor Summary

Constructors

Constructor and Description
MultiPageList(Function<Page,PageableList<T>> pageProvider) To list all the pages, starting with the very first one.
MultiPageList(Page startPage, Function<Page,PageableList<T>> pageProvider) To list all the pages, starting with the startPage specified.

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	add(T item)
boolean	addAll(Collection<? extends T> c)
boolean	addAll(int index, Collection<? extends T> c)
void	clear()
List<T>	collectAll() Iterate over multiple pages and collect the results to list
boolean	contains(Object o) Whether current page contains the specified object.
boolean	containsAll(Collection<?> c)
T	get(int index)
Map<String,String>	getLinks() Returns map of links.
Page	getNextPage() Returns description of the next page.
Paging	getPaging() Returns description of the current collection page.
boolean	hasNextPage() Signals whether there are more subsequent pages or the last page has been reached
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
T	set(int index, T element)
int	size() Returns size of the items collection on a current page.
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
int	totalSize() Returns size of entire collection across all pages.

Methods inherited from class com.gooddata.collections.PageableList

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

MultiPageList

public MultiPageList(Function<Page,PageableList<T>> pageProvider)

To list all the pages, starting with the very first one.

Parameters:

pageProvider - provider used to load the pages

MultiPageList

public MultiPageList(Page startPage,
                     Function<Page,PageableList<T>> pageProvider)

To list all the pages, starting with the startPage specified.

Parameters:

startPage - page to start with

pageProvider - provider used to load the pages

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface List<T>

Overrides:

iterator in class PageableList<T>

collectAll

public List<T> collectAll()

Iterate over multiple pages and collect the results to list

Overrides:

collectAll in class PageableList<T>

Returns:

list with all the results

getNextPage

public Page getNextPage()

Returns description of the next page.

Overrides:

getNextPage in class PageableList<T>

Returns:

next page, might be null

hasNextPage

public boolean hasNextPage()

Signals whether there are more subsequent pages or the last page has been reached

Overrides:

hasNextPage in class PageableList<T>

Returns:

true if there are more results to come

getLinks

public Map<String,String> getLinks()

Returns map of links.

Overrides:

getLinks in class PageableList<T>

Returns:

map of links, might be null

getPaging

public Paging getPaging()

Returns description of the current collection page.

Overrides:

getPaging in class PageableList<T>

Returns:

current collection page, might be null

size

public int size()

Returns size of the items collection on a current page. If you need the size of entire collection across all pages, use totalSize() instead.

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

Overrides:

size in class PageableList<T>

Returns:

size of the items collection on a current page

totalSize

public int totalSize()

Returns size of entire collection across all pages. It will fetch all the pages, so use wisely.

Returns:

size of entire collection across all pages

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

Overrides:

isEmpty in class PageableList<T>

contains

public boolean contains(Object o)

Whether current page contains the specified object. If you need to verify whether entire collection across all pages contains the object, use stream().anyMatch(o) instead.

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

Overrides:

contains in class PageableList<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Overrides:

toArray in class PageableList<T>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Overrides:

toArray in class PageableList<T>

add

public boolean add(T item)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Overrides:

add in class PageableList<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

Overrides:

remove in class PageableList<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

Overrides:

containsAll in class PageableList<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

Overrides:

addAll in class PageableList<T>

addAll

public boolean addAll(int index,
                      Collection<? extends T> c)

Specified by:

addAll in interface List<T>

Overrides:

addAll in class PageableList<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

Overrides:

removeAll in class PageableList<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

Overrides:

retainAll in class PageableList<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

Overrides:

clear in class PageableList<T>

get

public T get(int index)

Specified by:

get in interface List<T>

Overrides:

get in class PageableList<T>

set

public T set(int index,
             T element)

Specified by:

set in interface List<T>

Overrides:

set in class PageableList<T>

add

public void add(int index,
                T element)

Specified by:

add in interface List<T>

Overrides:

add in class PageableList<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

Overrides:

remove in class PageableList<T>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T>

Overrides:

indexOf in class PageableList<T>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T>

Overrides:

lastIndexOf in class PageableList<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

Overrides:

listIterator in class PageableList<T>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

Overrides:

listIterator in class PageableList<T>

subList

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

Specified by:

subList in interface List<T>

Overrides:

subList in class PageableList<T>