Package org.springframework.data.domain

Interface Pageable

All Known Implementing Classes:

AbstractPageRequest, PageRequest, QPageRequest

public interface Pageable

Abstract interface for pagination information.

Author:

Oliver Gierke, Mark Paluch, Christoph Strobl

Method Summary

Modifier and Type	Method	Description
Pageable	first()	Returns the Pageable requesting the first page.
long	getOffset()	Returns the offset to be taken according to the underlying page and page size.
int	getPageNumber()	Returns the page to be returned.
int	getPageSize()	Returns the number of items to be returned.
Sort	getSort()	Returns the sorting parameters.
default Sort	getSortOr(Sort sort)	Returns the current Sort or the given one if the current one is unsorted.
boolean	hasPrevious()	Returns whether there's a previous Pageable we can access from the current one.
default boolean	isPaged()	Returns whether the current Pageable contains pagination information.
default boolean	isUnpaged()	Returns whether the current Pageable does not contain pagination information.
Pageable	next()	Returns the Pageable requesting the next Page.
static Pageable	ofSize(int pageSize)	Creates a new Pageable for the first page (page number 0) given pageSize .
Pageable	previousOrFirst()	Returns the previous Pageable or the first Pageable if the current one already is the first one.
default Limit	toLimit()	Returns an Limit from this pageable if the page request is paged or Limit.unlimited() otherwise.
default Optional<Pageable>	toOptional()	Returns an Optional so that it can easily be mapped on.
default OffsetScrollPosition	toScrollPosition()	Returns an OffsetScrollPosition from this pageable if the page request is paged.
static Pageable	unpaged()	Returns a Pageable instance representing no pagination setup.
static Pageable	unpaged(Sort sort)	Returns a Pageable instance representing no pagination setup having a defined result order.
Pageable	withPage(int pageNumber)	Creates a new Pageable with pageNumber applied.

Method Details

unpaged

static Pageable unpaged()

Returns a Pageable instance representing no pagination setup.

unpaged

static Pageable unpaged(Sort sort)

Returns a Pageable instance representing no pagination setup having a defined result order.

Parameters:

sort - must not be null, use Sort.unsorted() if needed.

Returns:

an unpaged Pageable instance representing no pagination setup considering the given Sort order.

Since:

3.2

ofSize

static Pageable ofSize(int pageSize)

Creates a new Pageable for the first page (page number 0) given pageSize .

Parameters:

pageSize - the size of the page to be returned, must be greater than 0.

Returns:

a new Pageable.

Since:

2.5

isPaged

default boolean isPaged()

Returns whether the current Pageable contains pagination information.

Returns:

true if the current Pageable contains pagination information.

isUnpaged

default boolean isUnpaged()

Returns whether the current Pageable does not contain pagination information.

Returns:

true if the current Pageable does not contain pagination information.

getPageNumber

int getPageNumber()

Returns the page to be returned.

Returns:

the page to be returned or throws UnsupportedOperationException if the object is isUnpaged().

Throws:

UnsupportedOperationException - if the object is isUnpaged().

getPageSize

int getPageSize()

Returns the number of items to be returned.

Returns:

the number of items of that page or throws UnsupportedOperationException if the object is isUnpaged().

Throws:

UnsupportedOperationException - if the object is isUnpaged().

getOffset

long getOffset()

Returns the offset to be taken according to the underlying page and page size.

Returns:

the offset to be taken or throws UnsupportedOperationException if the object is isUnpaged().

Throws:

UnsupportedOperationException - if the object is isUnpaged().

getSort

Sort getSort()

Returns the sorting parameters.

Returns:

the sorting order.

getSortOr

default Sort getSortOr(Sort sort)

Returns the current Sort or the given one if the current one is unsorted.

Parameters:

sort - must not be null.

Returns:

the current Sort or the sort one if the current one is unsorted.

next

@Contract("-> new")
@CheckReturnValue
Pageable next()

Returns the Pageable requesting the next Page.

Returns:

the Pageable requesting the next Page.

previousOrFirst

@Contract("-> new")
@CheckReturnValue
Pageable previousOrFirst()

Returns the previous Pageable or the first Pageable if the current one already is the first one.

Returns:

the previous Pageable or the first Pageable if the current one already is the first one.

first

@Contract("-> new")
@CheckReturnValue
Pageable first()

Returns the Pageable requesting the first page.

Returns:

the Pageable requesting the first page.

withPage

@Contract("_ -> new")
@CheckReturnValue
Pageable withPage(int pageNumber)

Creates a new Pageable with pageNumber applied.

Parameters:

pageNumber - the page numbe, zero-based.

Returns:

a new PageRequest or throws UnsupportedOperationException if the object is isUnpaged() and the pageNumber is not zero.

Throws:

UnsupportedOperationException - if the object is isUnpaged().

Since:

2.5

hasPrevious

boolean hasPrevious()

Returns whether there's a previous Pageable we can access from the current one. Will return false in case the current Pageable already refers to the first page.

Returns:

true if there's a previous Pageable we can access from the current one.

toOptional

default Optional<Pageable> toOptional()

Returns an Optional so that it can easily be mapped on.

Returns:

an Optional so that it can easily be mapped on.

toLimit

default Limit toLimit()

Returns an Limit from this pageable if the page request is paged or Limit.unlimited() otherwise.

Returns:

a Limit object based on the current page size.

Since:

3.2

toScrollPosition

default OffsetScrollPosition toScrollPosition()

Returns an OffsetScrollPosition from this pageable if the page request is paged.

Given the exclusive nature of scrolling the ScrollPosition for Page(0, 10) translates an initial position, whereas Page(1, 10) will point to the last element of Page(0,10) resulting in ScrollPosition(9).

Returns:

new instance of OffsetScrollPosition.

Throws:

IllegalStateException - if the request is isUnpaged()

Since:

3.1