Module org.refcodes.hal

Package org.refcodes.hal

Interface HalDataPage

All Superinterfaces:

Collection<HalData>, Iterable<HalData>, List<HalData>

All Known Implementing Classes:

HalDataPageImpl

public interface HalDataPage
extends List<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. Pagainated 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.

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).

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 interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Field Details

PAGE_NUMBER

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

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

static final String PAGE_COUNT

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

See Also:

• Constant Field Values

Method Details

getPageNumber

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

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

int getPageCount()

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

Returns:

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