com.gooddata.collections

Class PageableList<E>

java.lang.Object

com.gooddata.collections.PageableList<E>

Type Parameters:

E - type of collection elements

All Implemented Interfaces:

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

Direct Known Subclasses:

Warehouses, WarehouseUsers

public class PageableList<E>
extends Object
implements List<E>

Wrapper over pageable GDC list.

Constructor Summary

Constructors

Constructor and Description
PageableList() Creates empty list with no next page.
PageableList(List<E> items, Paging paging) Creates list wrapping provided items and next page.
PageableList(List<E> items, Paging paging, Map<String,String> links) Creates list wrapping provided items, next page and links.

Method Summary

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)
E	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<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)
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()

Creates empty list with no next page.

PageableList

public PageableList(List<E> items,
                    Paging paging)

Creates list wrapping provided items and next page.

Parameters:

items - to be wrapped

paging - page description, might be null

PageableList

public PageableList(List<E> items,
                    Paging paging,
                    Map<String,String> links)

Creates list wrapping provided items, next page and links.

Parameters:

items - to be wrapped

paging - page description, might be null

links - links, might be null

Method Detail

getNextPage

public Page getNextPage()

Returns description of the next page.

Returns:

next page, might be null

hasNextPage

public boolean hasNextPage()

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

Returns:

true if there are more results to come

getLinks

public Map<String,String> getLinks()

Returns map of links.

Returns:

map of links, might be null

getPaging

public Paging getPaging()

Returns description of the current collection page.

Returns:

current collection page, might be null

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains 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>

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>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll 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>

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>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

get

public E get(int index)

Specified by:

get in interface List<E>

set

public E set(int index,
             E element)

Specified by:

set in interface List<E>

add

public void add(int index,
                E element)

Specified by:

add in interface List<E>

remove

public E remove(int index)

Specified by:

remove in interface List<E>

indexOf

public int indexOf(Object o)

Specified by:

indexOf 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>

subList

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

Specified by:

subList in interface List<E>