com.cinchapi.concourse.lang.paginate

Class NoPage

Object

NoPage

All Implemented Interfaces:

Page

public class NoPage
extends Object
implements Page

A specification for no Page.

Field Summary

Fields

Modifier and Type	Field and Description
static NoPage	INSTANCE Singleton instance.

Fields inherited from interface Page

DEFAULT_OFFSET, NO_LIMIT

Method Summary

Modifier and Type	Method and Description
Page	back() Return the "previous" Page, if possible.
Page	goTo(int page) Assuming this is the first Page, return the Page that simulates jumping to the specified pageNumber.
int	limit() Return the maximum number of items on the Page.
Page	next() Return the "next" Page.
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.
Page	resizeAll(int size) Set this Page to include up to size items with the assumption that all previous Pages contained size items.

Methods inherited from class Object

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

Methods inherited from interface Page

first, from, go, hasLimit, limit, none, number, of, offset, offsetLimit, previous, sized, skip, skip, skipLimit

Field Detail

INSTANCE

public static NoPage INSTANCE

Singleton instance.

Method Detail

back

public Page back()

Description copied from interface: Page

Return the "previous" Page, if possible. If this is already the first Page, it is returned from this method.

Specified by:

back in interface Page

Returns:

the previous Page

goTo

public Page goTo(int page)

Description copied from interface: Page

Assuming this is the first Page, return the Page that simulates jumping to the specified pageNumber.

Specified by:

goTo in interface Page

Returns:

the resulting Page

limit

public int limit()

Description copied from interface: Page

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.

Specified by:

limit in interface Page

Returns:

the limit

next

public Page next()

Description copied from interface: Page

Return the "next" Page.

This method returns a new Page whose skip/offset parameter is advanced by this pagination's limit.

Specified by:

next in interface Page

Returns:

the next Page

offset

public int offset()

Description copied from interface: Page

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

Specified by:

offset in interface Page

Returns:

the offset

resizeAll

public Page resizeAll(int size)

Description copied from interface: Page

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 Page.resize(int) method.

Specified by:

resizeAll in interface Page

Parameters:

size - the new page size

Returns:

the configured Page

resize

public Page resize(int size)

Description copied from interface: Page

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 Page.resizeAll(int) method.

Specified by:

resize in interface Page

Parameters:

size - the new page size

Returns:

the configured Page