Page (Blazebit Persistence Integration DeltaSpike Data API 1.2.0-Alpha5 API)

Type Parameters:

T - The element type

All Superinterfaces:

Iterable<T>

All Known Subinterfaces:

KeysetAwarePage<T>
```
public interface Page<T>
extends Iterable<T>
```
A sublist of a list of objects, heavily inspired by Spring Data's Page.

Since:

1.2.0

Author:

Christian Beikov

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Pageable`	`currentPageable()` Returns the `Pageable` that can be used to request the current Page.
`List<T>`	`getContent()` Returns the page content as Page.
`int`	`getNumber()` Returns the number of the current Page.
`int`	`getNumberOfElements()` Returns the actual number of elements currently on this Page.
`int`	`getSize()` Returns the size of the Page i.e. what was request via `Pageable.getPageSize()`.
`Sort`	`getSort()` Returns the sorting that was used for pagination.
`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`	`hasNext()` Returns if there is a next Page.
`boolean`	`hasPrevious()` Returns if there is a previous Page.
`boolean`	`isFirst()` Returns whether the current Page is the first one.
`boolean`	`isLast()` Returns whether the current Page is the last one.
`Pageable`	`nextPageable()` Returns the `Pageable` that can be used to request the next Page.
`Pageable`	`previousPageable()` Returns the `Pageable` that can be used to request the previous Page.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - getTotalPages
```
int getTotalPages()
```
    Returns the number of total pages.
    
    Returns:
    
    The number of total pages
  - getTotalElements
```
long getTotalElements()
```
    Returns the total amount of elements.
    
    Returns:
    
    The total amount of elements
  - getNumber
```
int getNumber()
```
    Returns the number of the current Page. Zero based.
    
    Returns:
    
    The number of the current Page.
  - getSize
```
int getSize()
```
    Returns the size of the Page i.e. what was request via Pageable.getPageSize().
    
    Returns:
    
    The size of the Page.
  - getNumberOfElements
```
int getNumberOfElements()
```
    Returns the actual number of elements currently on this Page.
    
    Returns:
    
    The actual number of elements currently on this Page.
  - getContent
```
List<T> getContent()
```
    Returns the page content as Page.
    
    Returns:
    
    The content of the Page
  - hasContent
```
boolean hasContent()
```
    Returns whether the Page has content at all.
    
    Returns:
    
    true if the content is non-empty, false otherwise
  - getSort
```
Sort getSort()
```
    Returns the sorting that was used for pagination.
    
    Returns:
    
    The sorting
  - isFirst
```
boolean isFirst()
```
    Returns whether the current Page is the first one.
    
    Returns:
    
    true if the getNumber() is 0, false otherwise
  - isLast
```
boolean isLast()
```
    Returns whether the current Page is the last one.
    
    Returns:
    
    true if the getNumber() is getTotalPages() - 1, false otherwise
  - hasNext
```
boolean hasNext()
```
    Returns if there is a next Page.
    
    Returns:
    
    true if the getNumber() is less than getTotalPages() - 1, false otherwise
  - hasPrevious
```
boolean hasPrevious()
```
    Returns if there is a previous Page.
    
    Returns:
    
    true if the getNumber() is greater than 0, false otherwise
  - currentPageable
```
Pageable currentPageable()
```
    Returns the Pageable that can be used to request the current Page.
    
    Returns:
    
    The Pageable for the current Page
  - nextPageable
```
Pageable nextPageable()
```
    Returns the Pageable that can be used to request the next Page. Returns null if hasNext() returns false.
    
    Returns:
    
    The Pageable for the next Page, or null if this is the last page
  - previousPageable
```
Pageable previousPageable()
```
    Returns the Pageable that can be used to request the previous Page. Returns null if hasPrevious() returns false.
    
    Returns:
    
    The Pageable for the previous Page, or null if this is the first page

Interface Page<T>

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

getTotalPages

getTotalElements

getNumber

getSize

getNumberOfElements

getContent

hasContent

getSort

isFirst

isLast

hasNext

hasPrevious

currentPageable

nextPageable

previousPageable