Package org.springframework.data.domain

Class AbstractPageRequest

java.lang.Object

org.springframework.data.domain.AbstractPageRequest

All Implemented Interfaces:

Serializable, Pageable

Direct Known Subclasses:

PageRequest, QPageRequest

public abstract class AbstractPageRequest
extends Object
implements Pageable, Serializable

Abstract Java Bean implementation of Pageable.

Author:

Thomas Darimont, Oliver Gierke, Alex Bondarev, Johannes Englmeier, Thach Le

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractPageRequest(int pageNumber, int pageSize)	Creates a new AbstractPageRequest.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
abstract 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.
int	hashCode()
boolean	hasPrevious()	Returns whether there's a previous Pageable we can access from the current one.
abstract Pageable	next()	Returns the Pageable requesting the next Page.
abstract Pageable	previous()	Returns the Pageable requesting the previous Page.
Pageable	previousOrFirst()	Returns the previous Pageable or the first Pageable if the current one already is the first one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.domain.Pageable

getSort, getSortOr, isPaged, isUnpaged, toOptional, toScrollPosition, withPage

Constructor Details

AbstractPageRequest

public AbstractPageRequest(int pageNumber,
 int pageSize)

Creates a new AbstractPageRequest. Pages are zero indexed, thus providing 0 for pageNumber will return the first pageNumber.

Parameters:

pageNumber - zero-based page number, must not be negative.

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

Method Details

getPageSize

public int getPageSize()

Description copied from interface: Pageable

Returns the number of items to be returned.

Specified by:

getPageSize in interface Pageable

Returns:

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

getPageNumber

public int getPageNumber()

Description copied from interface: Pageable

Returns the page to be returned.

Specified by:

getPageNumber in interface Pageable

Returns:

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

getOffset

public long getOffset()

Description copied from interface: Pageable

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

Specified by:

getOffset in interface Pageable

Returns:

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

hasPrevious

public boolean hasPrevious()

Description copied from interface: Pageable

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.

Specified by:

hasPrevious in interface Pageable

Returns:

previousOrFirst

public Pageable previousOrFirst()

Description copied from interface: Pageable

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

Specified by:

previousOrFirst in interface Pageable

Returns:

next

public abstract Pageable next()

Description copied from interface: Pageable

Returns the Pageable requesting the next Page.

Specified by:

next in interface Pageable

Returns:

previous

public abstract Pageable previous()

Returns the Pageable requesting the previous Page.

Returns:

first

public abstract Pageable first()

Description copied from interface: Pageable

Returns the Pageable requesting the first page.

Specified by:

first in interface Pageable

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object