Pageable (Spring Data Core 2.7.11 API)

All Known Implementing Classes:

AbstractPageRequest, PageRequest, QPageRequest
```
public interface Pageable
```
Abstract interface for pagination information.

Author:

Oliver Gierke, Mark Paluch

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and 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 Optional<Pageable>`	`toOptional()` Returns an `Optional` so that it can easily be mapped on.
`static Pageable`	`unpaged()` Returns a `Pageable` instance representing no pagination setup.
`Pageable`	`withPage(int pageNumber)` Creates a new `Pageable` with `pageNumber` applied.

- Method Detail
  - unpaged
```
static Pageable unpaged()
```
    Returns a Pageable instance representing no pagination setup.
    
    Returns:
  - 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:
  - isUnpaged
```
default boolean isUnpaged()
```
    Returns whether the current Pageable does not contain pagination information.
    
    Returns:
  - 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:
  - 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:
  - next
```
Pageable next()
```
    Returns the Pageable requesting the next Page.
    
    Returns:
  - previousOrFirst
```
Pageable previousOrFirst()
```
    Returns the previous Pageable or the first Pageable if the current one already is the first one.
    
    Returns:
  - first
```
Pageable first()
```
    Returns the Pageable requesting the first page.
    
    Returns:
  - withPage
```
Pageable withPage(int pageNumber)
```
    Creates a new Pageable with pageNumber applied.
    
    Parameters:
    
    pageNumber -
    
    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:
  - toOptional
```
default Optional<Pageable> toOptional()
```
    Returns an Optional so that it can easily be mapped on.
    
    Returns:

Interface Pageable

Method Summary

Method Detail

unpaged

ofSize

isPaged

isUnpaged

getPageNumber

getPageSize

getOffset

getSort

getSortOr

next

previousOrFirst

first

withPage

hasPrevious

toOptional