- All Implemented Interfaces:
Serializable
,Cloneable
,Iterable<HalData>
,Collection<HalData>
,List<HalData>
,RandomAccess
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The path to the total page count value (e.g. in anHttpBodyMap
).static final String
The path to the page's number value (e.g. in anHttpBodyMap
).static final String
The path to the page's size value (e.g. in anHttpBodyMap
).Fields inherited from class java.util.AbstractList
modCount
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default constructor for usage by sub-classes.HalDataPage
(int aPageNumber, int aPageSize, int aPageCount) Constructs theHalDataPage
instances with the given pagination metrics. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the total number of the pages which are available for retrieval.int
Returns the number of the page which thisHalDataPage
instances represents.int
Returns the maximum size of the page being requested for theHalDataPage
result set.Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, 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, removeIf, stream, toArray
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
The path to the page's number value (e.g. in anHttpBodyMap
).- See Also:
-
PAGE_SIZE
The path to the page's size value (e.g. in anHttpBodyMap
).- See Also:
-
PAGE_COUNT
The path to the total page count value (e.g. in anHttpBodyMap
).- See Also:
-
-
Constructor Details
-
HalDataPage
protected HalDataPage()Default constructor for usage by sub-classes. -
HalDataPage
public HalDataPage(int aPageNumber, int aPageSize, int aPageCount) Constructs theHalDataPage
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 thisHalDataPage
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 theHalDataPage
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..
-