Page (Concourse Java API)

All Known Implementing Classes:

NoPage
```
@Immutable
public interface Page
```
A Page contains a subset of data. The data on a Page is determined by applying an offset and limit to a data set with a consistent order.
Effectively, a Page encapsulates the limit and skip/offset parameters that can be used to pagination through a result set.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_OFFSET` The default number of items to skip before adding items to a `Page`.
`static int`	`NO_LIMIT` Return the value that represents a `Page` with no limit.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Page`	`back()` Return the "previous" `Page`, if possible.
`static Page`	`first()` Deprecated. use `#skipLimit(int, int)` instead
`static Page`	`from(PageTree tree)` Return a `Page` based on the parsed statement that produced the `PageTree`.
`default Page`	`go(int page)` Deprecated. use `goTo(int)` instead
`default Page`	`goTo(int pageNumber)` Assuming this is the first `Page`, return the `Page` that simulates jumping to the specified `pageNumber`.
`default boolean`	`hasLimit()` Return `true` if this `Page` has an explicit limit.
`int`	`limit()` Return the maximum number of items on the `Page`.
`static Page`	`limit(int size)` Return the first `Page` with `size` items.
`Page`	`next()` Return the "next" `Page`.
`static Page`	`none()` Return a `Page` that represents no specific `Page` and implies that all items in a result set should be included.
`static Page`	`number(int number)` Deprecated. use `#skipLimit(int, int)` instead
`static Page`	`of(int skip, int limit)` Deprecated. use `#skipLimit(int, int)` instead
`int`	`offset()` Return the number of items to "skip" (inclusive) before adding items to the `Page`.
`static Page`	`offset(int offset)` Return a `Page` that results from skipping the specified number of items.
`static Page`	`offsetLimit(int offset, int limit)` Return a `Page` with explicit `offset` and `limit` parameters.
`default Page`	`previous()` Return the "previous" `Page`, if possible.
`Page`	`resize(int size)` Set this `Page` to include up to `size` items.
`Page`	`resizeAll(int size)` Set this `Page` to include up to `size` items with the assumption that all previous `Pages` contained `size` items.
`static Page`	`sized(int size)` Deprecated. use `limit(int)` instead
`default int`	`skip()` An alias for `offset()`.
`static Page`	`skip(int skip)` Return a `Page` that results from skipping the specified number of items.
`static Page`	`skipLimit(int skip, int limit)` Return a `Page` with explicit `skip` and `limit` parameters.

- Field Detail
  - DEFAULT_OFFSET
```
static final int DEFAULT_OFFSET
```
    The default number of items to skip before adding items to a Page.
    
    See Also:
    
    Constant Field Values
  - NO_LIMIT
```
static final int NO_LIMIT
```
    Return the value that represents a Page with no limit.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - first
```
@Deprecated
static Page first()
```
    Deprecated. use #skipLimit(int, int) instead
    
    Return the first Page
    
    Returns:
    
    the first Page
  - from
```
static Page from(PageTree tree)
```
    Return a Page based on the parsed statement that produced the PageTree.
    
    Parameters:
    
    tree - the parsed PageTree
    
    Returns:
    
    the associated Page
  - limit
```
static Page limit(int size)
```
    Return the first Page with size items.
    
    Parameters:
    
    size - the number of items per page
    
    Returns:
    
    the first Page with size items
  - none
```
static Page none()
```
    Return a Page that represents no specific Page and implies that all items in a result set should be included.
    
    Returns:
    
    a no-op Page
  - number
```
@Deprecated
static Page number(int number)
```
    Deprecated. use #skipLimit(int, int) instead
    
    Return the Page at number.
    
    Parameters:
    
    number -
    
    Returns:
    
    the number Page
  - of
```
@Deprecated
static Page of(int skip,
                           int limit)
```
    Deprecated. use #skipLimit(int, int) instead
    
    Return a Page with explicit skip and limit parameters.
    
    Parameters:
    
    skip -
    
    limit -
    
    Returns:
    
    the Page
  - offset
```
static Page offset(int offset)
```
    Return a Page that results from skipping the specified number of items.
    
    Parameters:
    
    offset - the number of items to skip (0-indexed)
    
    Returns:
    
    the Page
  - offsetLimit
```
static Page offsetLimit(int offset,
                        int limit)
```
    Return a Page with explicit offset and limit parameters.
    
    Parameters:
    
    offset - the number of items to skip
    
    limit - the maximum number of items to return
    
    Returns:
    
    the Page
  - sized
```
@Deprecated
static Page sized(int size)
```
    Deprecated. use limit(int) instead
    
    Return the first Page with size items.
    
    Parameters:
    
    size -
    
    Returns:
    
    the first Page with size items
  - skip
```
static Page skip(int skip)
```
    Return a Page that results from skipping the specified number of items.
    
    Parameters:
    
    skip - the number of items to skip (0-indexed)
    
    Returns:
    
    the Page
  - skipLimit
```
static Page skipLimit(int skip,
                      int limit)
```
    Return a Page with explicit skip and limit parameters.
    
    Parameters:
    
    skip - the number of items to skip
    
    limit - the maximum number of items to return
    
    Returns:
    
    the Page
  - back
```
Page back()
```
    Return the "previous" Page, if possible. If this is already the first Page, it is returned from this method.
    
    Returns:
    
    the previous Page
  - go
```
@Deprecated
default Page go(int page)
```
    Deprecated. use goTo(int) instead
    
    Jump to page Page while keeping the same limit.
    
    Parameters:
    
    page -
    
    Returns:
    
    the specified page
  - goTo
```
default Page goTo(int pageNumber)
```
    Assuming this is the first Page, return the Page that simulates jumping to the specified pageNumber.
    
    Parameters:
    
    pageNumber -
    
    Returns:
    
    the resulting Page
  - hasLimit
```
default boolean hasLimit()
```
    Return true if this Page has an explicit limit.
    
    Returns:
    
    a boolean that indicates if this page does or does not have an explicit limit
  - limit
```
int limit()
```
    Return the maximum number of items on the Page. The number of items returned may be less than this value if there are fewer than limit items remaining in the data set.
    
    Returns:
    
    the limit
  - next
```
Page next()
```
    Return the "next" Page.
    This method returns a new Page whose skip/offset parameter is advanced by this pagination's limit.
    
    Returns:
    
    the next Page
  - offset
```
int offset()
```
    Return the number of items to "skip" (inclusive) before adding items to the Page.
    
    Returns:
    
    the offset
  - previous
```
default Page previous()
```
    Return the "previous" Page, if possible. If this is already the first Page, it is returned from this method.
    
    Returns:
    
    the previous Page
  - resize
```
Page resize(int size)
```
    Set this Page to include up to size items.
    NOTE: This method only modifies the current page size instead of recalculating all the items on the current Page as if all preceding Pages also had size items. If you want to modify this Page to include size items in a manner that assumes preceding Pages also contained size items, use the resizeAll(int) method.
    
    Parameters:
    
    size - the new page size
    
    Returns:
    
    the configured Page
  - resizeAll
```
Page resizeAll(int size)
```
    Set this Page to include up to size items with the assumption that all previous Pages contained size items.
    NOTE: This method recalculates all the items on the current Page as if all preceding Pages also had size items. If you want to modify this Page to include size without modifying the assumptions about what was contained on previous Pages, use the resize(int) method.
    
    Parameters:
    
    size - the new page size
    
    Returns:
    
    the configured Page
  - skip
```
default int skip()
```
    An alias for offset().
    
    Returns:
    
    the offset

Interface Page

Field Summary

Method Summary

Field Detail

DEFAULT_OFFSET

NO_LIMIT

Method Detail

first

from

limit

none

number

of

offset

offsetLimit

sized

skip

skipLimit

back

go

goTo

hasLimit

limit

next

offset

previous

resize

resizeAll

skip