Spring Data Core

org.springframework.data.domain
Class PageRequest

java.lang.Object
  extended by org.springframework.data.domain.PageRequest
All Implemented Interfaces:
Serializable, Pageable

public class PageRequest
extends Object
implements Pageable, Serializable

Basic Java Bean implementation of Pageable.

Author:
Oliver Gierke
See Also:
Serialized Form

Constructor Summary
PageRequest(int page, int size)
          Creates a new PageRequest.
PageRequest(int page, int size, Sort.Direction direction, String... properties)
          Creates a new PageRequest with sort parameters applied.
PageRequest(int page, int size, Sort sort)
          Creates a new PageRequest with sort parameters applied.
 
Method Summary
 boolean equals(Object obj)
           
 Pageable first()
          Returns the Pageable requesting the first page.
 int 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.
 int hashCode()
           
 boolean hasPrevious()
          Returns whether there's a previous Pageable we can access from the current one.
 Pageable next()
          Returns the Pageable requesting the next Page.
 Pageable previousOrFirst()
          Returns the previous Pageable or the first Pageable if the current one already is the first one.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PageRequest

public PageRequest(int page,
                   int size)
Creates a new PageRequest. Pages are zero indexed, thus providing 0 for page will return the first page.

Parameters:
size -
page -

PageRequest

public PageRequest(int page,
                   int size,
                   Sort.Direction direction,
                   String... properties)
Creates a new PageRequest with sort parameters applied.

Parameters:
page -
size -
direction -
properties -

PageRequest

public PageRequest(int page,
                   int size,
                   Sort sort)
Creates a new PageRequest with sort parameters applied.

Parameters:
page -
size -
sort - can be null.
Method Detail

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

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.

getOffset

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

getSort

public Sort getSort()
Description copied from interface: Pageable
Returns the sorting parameters.

Specified by:
getSort in interface Pageable
Returns:

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:

next

public Pageable next()
Description copied from interface: Pageable
Returns the Pageable requesting the next Page.

Specified by:
next 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:

first

public Pageable first()
Description copied from interface: Pageable
Returns the Pageable requesting the first page.

Specified by:
first in interface Pageable
Returns:

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

Spring Data Core

Copyright © 2011-2013-2013 Pivotal. All Rights Reserved.