Package rs.jerseyclient.data

Class ResultList<T>

java.lang.Object

rs.jerseyclient.data.ResultList<T>

Type Parameters:

T - the type of result

All Implemented Interfaces:

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

public class ResultList<T>
extends Object
implements List<T>

Special list that also holds page information.

The class is usually required for correct JSON (de)serialization while easing the use.

Author:

ralph

Constructor Summary

Constructors

Constructor	Description
ResultList()	Default constructor.
ResultList(List<T> results, PageInfo pageInfo)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
boolean	add(T e)
boolean	addAll(int index, Collection<? extends T> c)
boolean	addAll(Collection<? extends T> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
void	forEach(Consumer<? super T> action)
T	get(int index)
int	getPageNumber()	Returns the number of the current page.
int	getPageSize()	Returns the results page size.
int	getTotalElements()	Returns the total number of results.
int	getTotalPages()	Returns the total number of pages.
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
Stream<T>	parallelStream()
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	removeIf(Predicate<? super T> filter)
void	replaceAll(UnaryOperator<T> operator)
boolean	retainAll(Collection<?> c)
T	set(int index, T element)
int	size()
void	sort(Comparator<? super T> c)
Spliterator<T>	spliterator()
Stream<T>	stream()
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<X> X[]	toArray(IntFunction<X[]> generator)
<X> X[]	toArray(X[] a)

Methods inherited from class java.lang.Object

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

Constructor Details

ResultList

public ResultList()

Default constructor.

ResultList

public ResultList(List<T> results,
 PageInfo pageInfo)

Constructor.

Parameters:

results - - results of the response

pageInfo - - page information

Method Details

forEach

public void forEach(Consumer<? super T> action)

Specified by:

forEach in interface Iterable<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface List<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

toArray

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

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

addAll

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

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

addAll

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

Specified by:

addAll in interface List<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

replaceAll

public void replaceAll(UnaryOperator<T> operator)

Specified by:

replaceAll in interface List<T>

toArray

public <X> X[] toArray(IntFunction<X[]> generator)

Specified by:

toArray in interface Collection<T>

sort

public void sort(Comparator<? super T> c)

Specified by:

sort in interface List<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Overrides:

hashCode in class Object

get

public T get(int index)

Specified by:

get in interface List<T>

set

public T set(int index,
 T element)

Specified by:

set in interface List<T>

add

public void add(int index,
 T element)

Specified by:

add in interface List<T>

removeIf

public boolean removeIf(Predicate<? super T> filter)

Specified by:

removeIf in interface Collection<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

subList

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

Specified by:

subList in interface List<T>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Collection<T>

Specified by:

spliterator in interface Iterable<T>

Specified by:

spliterator in interface List<T>

stream

public Stream<T> stream()

Specified by:

stream in interface Collection<T>

parallelStream

public Stream<T> parallelStream()

Specified by:

parallelStream in interface Collection<T>

getPageSize

public int getPageSize()

Returns the results page size.

Returns:

the results page size

getTotalElements

public int getTotalElements()

Returns the total number of results.

Returns:

the total number of results

getTotalPages

public int getTotalPages()

Returns the total number of pages.

Returns:

the total number of pages

getPageNumber

public int getPageNumber()

Returns the number of the current page.

Returns:

the number of the current page