org.springframework.data.domain
Interface Page<T>

Type Parameters:

T -

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

PageImpl

public interface Page<T>
extends Iterable<T>

A page is a sublist of a list of objects. It allows gain information about the position of it in the containing entire list.

Author:

Oliver Gierke

Method Summary

List<T>	getContent() Returns the page content as List.
int	getNumber() Returns the number of the current page.
int	getNumberOfElements() Returns the number of elements currently on this page.
int	getSize() Returns the size of the page.
Sort	getSort() Returns the sorting parameters for the page.
long	getTotalElements() Returns the total amount of elements.
int	getTotalPages() Returns the number of total pages.
boolean	hasContent() Returns whether the Page has content at all.
boolean	hasNextPage() Returns if there is a next page.
boolean	hasPreviousPage() Returns if there is a previous page.
boolean	isFirstPage() Returns whether the current page is the first one.
boolean	isLastPage() Returns whether the current page is the last one.
Iterator<T>	iterator()
Pageable	nextPageable() Returns the Pageable to request the next Page.
Pageable	previousPageable() Returns the Pageable to request the previous page.

Method Detail

getNumber

int getNumber()

Returns the number of the current page. Is always non-negative and less that Page#getTotalPages().

Returns:

the number of the current page

getSize

int getSize()

Returns the size of the page.

Returns:

the size of the page

getTotalPages

int getTotalPages()

Returns the number of total pages.

Returns:

the number of toral pages

getNumberOfElements

int getNumberOfElements()

Returns the number of elements currently on this page.

Returns:

the number of elements currently on this page

getTotalElements

long getTotalElements()

Returns the total amount of elements.

Returns:

the total amount of elements

hasPreviousPage

boolean hasPreviousPage()

Returns if there is a previous page.

Returns:

if there is a previous page

isFirstPage

boolean isFirstPage()

Returns whether the current page is the first one.

Returns:

hasNextPage

boolean hasNextPage()

Returns if there is a next page.

Returns:

if there is a next page

isLastPage

boolean isLastPage()

Returns whether the current page is the last one.

Returns:

nextPageable

Pageable nextPageable()

Returns the Pageable to request the next Page. Can be null in case the current Page is already the last one. Clients should check hasNextPage() before calling this method to make sure they receive a non-null value.

Returns:

previousPageable

Pageable previousPageable()

Returns the Pageable to request the previous page. Can be null in case the current Page is already the first one. Clients should check hasPreviousPage() before calling this method make sure receive a non-null value.

Returns:

iterator

Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

getContent

List<T> getContent()

Returns the page content as List.

Returns:

hasContent

boolean hasContent()

Returns whether the Page has content at all.

Returns:

getSort

Sort getSort()

Returns the sorting parameters for the page.

Returns: