com.cinchapi.concourse.lang.paginate

Class Page

Object

Page

@Immutable
public final class Page
extends Object

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.

Method Summary

Modifier and Type	Method and Description
Page	back() Return the "previous" Page, if possible.
boolean	equals(Object obj)
static Page	first() Return the first Page
Page	go(int page) Jump to page Page while keeping the same limit.
int	hashCode()
int	limit() Return the maximum number of items on the page.
Page	next() Return the "next" Page.
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.
int	skip() An alias for offset().

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

first

public static Page first()

Return the first Page

Returns:

the first Page

number

public static Page number(int number)

Return the Page at number.

Parameters:

number -

Returns:

the number Page

of

public static Page of(int skip,
                      int limit)

Return a Page with explicit skip and limit parameters.

Parameters:

skip -

limit -

Returns:

the Page

sized

public static Page sized(int size)

Return the first Page with size items.

Parameters:

size -

Returns:

the first Page with size items

back

public 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

go

public Page go(int page)

Jump to page Page while keeping the same limit.

Parameters:

page -

Returns:

the specified page

hashCode

public int hashCode()

Overrides:

hashCode in class Object

limit

public 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

public 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

public int offset()

Return the number of items to "skip" (inclusive) before adding items to the page.

Returns:

the offset

resize

public 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

public 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 preceeding 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

public int skip()

An alias for offset().

Returns:

the offset