HalDataPageImpl
public interface HalDataPage extends List<HalData>
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.Modifier and Type | Field | Description |
---|---|---|
static String |
PAGE_COUNT |
The path to the total page count value (e.g. in an
HttpBodyMap ). |
static String |
PAGE_NUMBER |
The path to the page's number value (e.g. in an
HttpBodyMap ). |
static String |
PAGE_SIZE |
The path to the page's size value (e.g. in an
HttpBodyMap ). |
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. |
parallelStream, removeIf, stream
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray
static final String PAGE_NUMBER
HttpBodyMap
).static final String PAGE_SIZE
HttpBodyMap
).static final String PAGE_COUNT
HttpBodyMap
).int getPageNumber()
HalDataPage
instances
represents.HalDataPage
result set's page number as of
pagination.int getPageSize()
HalDataPage
result set. Returns -1 in case no page size has been
specified.HalDataPage
result set's page size as of pagination.int getPageCount()
Copyright © 2021. All rights reserved.