io.tronalddump.client

Class Page<T>

java.lang.Object

io.tronalddump.client.Page<T>

Type Parameters:

T - the type of the objects contained in the page

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<T>

public class Page<T>
extends java.lang.Object
implements java.lang.Iterable<T>, java.io.Serializable

The class representing a page. Inspired on Spring Data's Page (http://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/domain/Page.html).

Since:

1.0.0

Author:

Marcel Overdijk

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Page(java.util.List<T> content, Pageable pageable, long total) Creates a new Page with the given content, pageable and total count.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<T>	getContent() Returns the page content as List.
int	getNumber() Returns the page number.
int	getNumberOfElements() Returns the number of elements currently on this Page.
int	getSize() Returns the page size.
long	getTotalElements() Returns the total amount of elements.
int	getTotalPages() Returns the number of total pages.
boolean	hasContent() Returns whether the page has content.
int	hashCode()
boolean	hasNext() Returns whether there is a next Page.
boolean	hasPrevious() Returns whether 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.
java.util.Iterator<T>	iterator()
Pageable	nextPageable() Returns the Pageable to request the next Page.
Pageable	previousPageable() Returns the Pageable to request the previous Page.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Page

public Page(java.util.List<T> content,
            Pageable pageable,
            long total)

Creates a new Page with the given content, pageable and total count.

Parameters:

content - the content

pageable - the pageable

total - the total, must not be less than 0

Method Detail

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

hasContent

public boolean hasContent()

Returns whether the page has content.

getContent

public java.util.List<T> getContent()

Returns the page content as List.

Returns:

the page content

getNumber

public int getNumber()

Returns the page number.

Returns:

the page number

getSize

public int getSize()

Returns the page size.

Returns:

the page size

getNumberOfElements

public int getNumberOfElements()

Returns the number of elements currently on this Page.

Returns:

the number of elements

getTotalPages

public int getTotalPages()

Returns the number of total pages.

Returns:

the number of total pages

getTotalElements

public long getTotalElements()

Returns the total amount of elements.

Returns:

the total amount of elements

hasNext

public boolean hasNext()

Returns whether there is a next Page.

hasPrevious

public boolean hasPrevious()

Returns whether there is a previous Page.

isFirst

public boolean isFirst()

Returns whether the current Page is the first one.

isLast

public boolean isLast()

Returns whether the current Page is the last one.

nextPageable

public Pageable nextPageable()

Returns the Pageable to request the next Page.

Returns:

the next pageable, or null if there is no next page

previousPageable

public Pageable previousPageable()

Returns the Pageable to request the previous Page.

Returns:

the previous pageable, or null if there is no previous page

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object