com.gooddata.collections

Class PageableList<E>

java.lang.Object

com.gooddata.collections.PageableList<E>

Type Parameters:

E - type of collection elements

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>

Direct Known Subclasses:

Warehouses, WarehouseUsers

public class PageableList<E>
extends java.lang.Object
implements java.util.List<E>

Wrapper over pageable GDC list.

Constructor Summary

Constructors

Constructor and Description
PageableList() Creates empty list with no next page.
PageableList(java.util.List<E> items, Paging paging) Creates list wrapping provided items and next page.
PageableList(java.util.List<E> items, Paging paging, java.util.Map<java.lang.String,java.lang.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(java.util.Collection<? extends E> c)
boolean	addAll(int index, java.util.Collection<? extends E> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
E	get(int index)
java.util.Map<java.lang.String,java.lang.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(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<E>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
E	set(int index, E element)
int	size()
java.util.List<E>	subList(int fromIndex, int toIndex)
java.lang.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(java.util.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(java.util.List<E> items,
                    Paging paging,
                    java.util.Map<java.lang.String,java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.List<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.List<E>

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.List<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

toArray

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

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.List<E>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.List<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.List<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.List<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

set

public E set(int index,
             E element)

Specified by:

set in interface java.util.List<E>

add

public void add(int index,
                E element)

Specified by:

add in interface java.util.List<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<E>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<E>

listIterator

public java.util.ListIterator<E> listIterator()

Specified by:

listIterator in interface java.util.List<E>

listIterator

public java.util.ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface java.util.List<E>

subList

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

Specified by:

subList in interface java.util.List<E>