org.nuiton.util.pagination

Class PaginationResult<O>

java.lang.Object

org.nuiton.util.pagination.PaginationResult<O>

All Implemented Interfaces:

Serializable

public class PaginationResult<O>
extends Object
implements Serializable

Represents the result of a pagination request. It contains the result elements together with the PaginationParameter used to compute it. The class also contains methods to navigate through the other pages.

Since:

3.0

Author:

Arnaud Thimel (Code Lutin)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	count
protected PaginationParameter	currentPage
protected List<O>	elements

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PaginationResult(List<O> elements, long count, PaginationParameter currentPage)

Method Summary

Modifier and Type	Method and Description
static <T> PaginationResult<T>	fromFullList(List<T> fullList, PaginationParameter requestedPage) Creates an instance using the full list of elements ({code}fullList{/code}) and the {code}requestedPage{/code} PaginationParameter.
long	getCount()
PaginationParameter	getCurrentPage()
List<O>	getElements()
PaginationParameter	getFirstPage()
PaginationParameter	getLastPage()
PaginationParameter	getNextPage()
int	getPageCount()
PaginationParameter	getPreviousPage()
boolean	hasNextPage()
boolean	hasPreviousPage()
static <T> PaginationResult<T>	of(List<T> elements, long count, PaginationParameter currentPage) Creates an instance using the already computed list of {code}elements{/code} and {code}count{/count}, together with the {code}currentPage{/code} PaginationParameter used to build it.
<T> PaginationResult<T>	transform(Function<? super O,? extends T> function) Creates an instance of PaginationResult transforming the current one using the given function

Methods inherited from class java.lang.Object

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

Field Detail

elements

protected List<O> elements

count

protected long count

currentPage

protected PaginationParameter currentPage

Constructor Detail

PaginationResult

protected PaginationResult(List<O> elements,
                           long count,
                           PaginationParameter currentPage)

Method Detail

of

public static <T> PaginationResult<T> of(List<T> elements,
                                         long count,
                                         PaginationParameter currentPage)

Creates an instance using the already computed list of {code}elements{/code} and {code}count{/count}, together with the {code}currentPage{/code} PaginationParameter used to build it.

Type Parameters:

T - any object type

Parameters:

elements - the list of elements

count - the total number of elements (through all pages)

currentPage - the PaginationParameter used to build this paged result

Returns:

the built instance of PaginationResult

fromFullList

public static <T> PaginationResult<T> fromFullList(List<T> fullList,
                                                   PaginationParameter requestedPage)

Creates an instance using the full list of elements ({code}fullList{/code}) and the {code}requestedPage{/code} PaginationParameter. The built instance of PaginationResult will contain a sub list of the given {code}fullList{/code} parameter.

Type Parameters:

T - any object type

Parameters:

fullList - the full list of elements

requestedPage - the PaginationParameter to use to build this paged result

Returns:

the built instance of PaginationResult.

getElements

public List<O> getElements()

getCount

public long getCount()

getCurrentPage

public PaginationParameter getCurrentPage()

getNextPage

public PaginationParameter getNextPage()

getPreviousPage

public PaginationParameter getPreviousPage()

getFirstPage

public PaginationParameter getFirstPage()

getLastPage

public PaginationParameter getLastPage()

getPageCount

public int getPageCount()

hasNextPage

public boolean hasNextPage()

hasPreviousPage

public boolean hasPreviousPage()

transform

public <T> PaginationResult<T> transform(Function<? super O,? extends T> function)

Creates an instance of PaginationResult transforming the current one using the given function