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_LIMIT` The default number of items to include on a Page.
`static int`	`DEFAULT_OFFSET` The default number of items to skip before adding items to a Page.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Page`	`back()` Return the "previous" `Page`, if possible.
`static Page`	`first()` Return the first `Page`
`static Page`	`from(PageTree tree)` Return a `Page` based on the parsed statement that produced the `PageTree`.
`Page`	`go(int page)` Jump to `page` `Page` while keeping the same limit.
`int`	`limit()` Return the maximum number of items on the page.
`Page`	`next()` Return the "next" `Page`.
`static Page`	`none()` Return a `Page` that specifies no specific Page and implies that all items in a result set should be included.
`static Page`	`number(int number)` Return the `Page` at `number`.
`static Page`	`of(int skip, int limit)` Return a `Page` with explicit `skip` and `limit` parameters.
`int`	`offset()` Return the number of items to "skip" (inclusive) before adding items to the page.
`Page`	`resize(int size)` Set this `Page` to include up to `size` items with the assumption that all previous pages contained `size` items.
`Page`	`size(int size)` Set this `Page` to include up to `size` items.
`static Page`	`sized(int size)` Return the first `Page` with `size` items.
`default int`	`skip()` An alias for `offset()`.

- Field Detail
  - DEFAULT_LIMIT
```
static final int DEFAULT_LIMIT
```
    The default number of items to include on a Page.
    
    See Also:
    
    Constant Field Values
  - 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
- Method Detail
  - none
```
static Page none()
```
    Return a Page that specifies no specific Page and implies that all items in a result set should be included.
    
    Returns:
    
    a no-op Page
  - first
```
static Page first()
```
    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 -
    
    Returns:
    
    the associated Page
  - number
```
static Page number(int number)
```
    Return the Page at number.
    
    Parameters:
    
    number -
    
    Returns:
    
    the number Page
  - of
```
static Page of(int skip,
               int limit)
```
    Return a Page with explicit skip and limit parameters.
    
    Parameters:
    
    skip -
    
    limit -
    
    Returns:
    
    the Page
  - sized
```
static Page sized(int size)
```
    Return the first Page with size items.
    
    Parameters:
    
    size -
    
    Returns:
    
    the first Page with size items
  - 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
```
Page go(int page)
```
    Jump to page Page while keeping the same limit.
    
    Parameters:
    
    page -
    
    Returns:
    
    the specified page
  - 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
  - resize
```
Page resize(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 preceeding 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 size(int) method.
    
    Parameters:
    
    size -
    
    Returns:
    
    the configured Page
  - size
```
Page size(int size)
```
    Set this Page to include up to size items.
    NOTE: This method only modifies the current page size (e.g. adds/removes) items 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 resize(int) method.
    
    Parameters:
    
    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_LIMIT

DEFAULT_OFFSET

Method Detail

none

first

from

number

of

sized

back

go

limit

next

offset

resize

size

skip