Module org.refcodes.hal

Package org.refcodes.hal

Class HalDataPage

java.lang.Object

java.util.AbstractCollection<HalData>

java.util.AbstractList<HalData>

java.util.ArrayList<HalData>

org.refcodes.hal.HalDataPage

All Implemented Interfaces:

Serializable, Cloneable, Iterable<HalData>, Collection<HalData>, List<HalData>, RandomAccess, SequencedCollection<HalData>

public class HalDataPage
extends ArrayList<HalData>

In case the a paginated result set is expected when querying the HalClient, then a HalDataPage will be returned containing the the HalData instances correlating to the requested page as well as additional information about the number of total pages available. Paginated result sets may be expected when calling methods such as HalClient.readPage(String, int, int) or HalClient.readAll(String, org.refcodes.web.FormFields) (or similar) with HTTP-Query-Fields querying a paginated result.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAGE_COUNT	The path to the total page count value (e.g. in an HttpBodyMap).
static final String	PAGE_NUMBER	The path to the page's number value (e.g. in an HttpBodyMap).
static final String	PAGE_SIZE	The path to the page's size value (e.g. in an HttpBodyMap).

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HalDataPage()	Default constructor for usage by sub-classes.
	HalDataPage(int aPageNumber, int aPageSize, int aPageCount)	Constructs the HalDataPage instances with the given pagination metrics.

Method Summary

Modifier and Type	Method	Description
int	getPageCount()	Returns the total number of the pages which are available for retrieval.
int	getPageNumber()	Returns the number of the page which this HalDataPage instances represents.
int	getPageSize()	Returns the maximum size of the page being requested for the HalDataPage result set.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Field Details

PAGE_NUMBER

public static final String PAGE_NUMBER

The path to the page's number value (e.g. in an HttpBodyMap).

See Also:

• Constant Field Values

PAGE_SIZE

public static final String PAGE_SIZE

The path to the page's size value (e.g. in an HttpBodyMap).

See Also:

• Constant Field Values

PAGE_COUNT

public static final String PAGE_COUNT

The path to the total page count value (e.g. in an HttpBodyMap).

See Also:

• Constant Field Values

Constructor Details

HalDataPage

protected HalDataPage()

Default constructor for usage by sub-classes.

HalDataPage

public HalDataPage(int aPageNumber,
 int aPageSize,
 int aPageCount)

Constructs the HalDataPage instances with the given pagination metrics.

Parameters:

aPageNumber - The page's number as of pagination.

aPageSize - The page's size as of pagination.

aPageCount - The total page count of the overall result set.

Method Details

getPageNumber

public int getPageNumber()

Returns the number of the page which this HalDataPage instances represents.

Returns:

The HalDataPage result set's page number as of pagination.

getPageSize

public int getPageSize()

Returns the maximum size of the page being requested for the HalDataPage result set. Returns -1 in case no page size has been specified.

Returns:

The HalDataPage result set's page size as of pagination.

getPageCount

public int getPageCount()

Returns the total number of the pages which are available for retrieval.

Returns:

The total number of the pages representing the overall result set..