Package de.digitalcollections.model.impl.paging

Class PageResponseImpl<T>

java.lang.Object

de.digitalcollections.model.impl.paging.PageResponseImpl<T>

All Implemented Interfaces:

PageResponse<T>, java.lang.Iterable<T>

Direct Known Subclasses:

SearchPageResponseImpl

public class PageResponseImpl<T>
extends java.lang.Object
implements PageResponse<T>

Constructor Summary

Constructors

Constructor	Description
PageResponseImpl()
PageResponseImpl(java.util.List<T> content)	Creates a new PageResponseImpl with the given content.
PageResponseImpl(java.util.List<T> content, PageRequest pageRequest, long total)	Constructor of PageResponseImpl with the given content and the given governing PageRequest.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.List<T>	getContent()
int	getNumber()	Returns the number of the current PageResponse.
int	getNumberOfElements()	Returns the number of elements currently on this PageResponse.
PageRequest	getPageRequest()
int	getSize()	Returns the size of the PageResponse.
Sorting	getSorting()
long	getTotalElements()	Returns the total amount of elements.
int	getTotalPages()	Returns the number of total pages.
boolean	hasContent()	Returns whether the PageResponse has content at all.
int	hashCode()
boolean	hasNext()	Returns if there is a next PageResponse.
boolean	hasPrevious()	Returns if there is a previous PageResponse.
boolean	isFirst()	Returns whether the current PageResponse is the first one.
boolean	isLast()	Returns whether the current PageResponse is the last one.
java.util.Iterator<T>	iterator()
PageRequest	nextPageRequest()	Returns the PageRequest to request the next PageResponse.
PageRequest	previousPageRequest()	Returns the PageRequest to request the previous PageResponse.
void	setContent(java.util.List<T> content)	Allows to set the content (needed in case of content has to be converted/casted)
void	setPageRequest(PageRequest pageRequest)
void	setTotalElements(long totalElements)
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 Details

PageResponseImpl

public PageResponseImpl()

PageResponseImpl

public PageResponseImpl(java.util.List<T> content,
PageRequest pageRequest,
long total)

Constructor of PageResponseImpl with the given content and the given governing PageRequest.

Parameters:

content - the content of this page, must not be null.

pageRequest - the paging information, can be null.

total - the total amount of items available. The total might be adapted considering the length of the content given, if it is going to be the content of the last page. This is in place to mitigate inconsistencies

PageResponseImpl

public PageResponseImpl(java.util.List<T> content)

Creates a new PageResponseImpl with the given content. This will result in the created PageResponse being identical to the entire List.

Parameters:

content - must not be null.

Method Details

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getContent

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

Specified by:

getContent in interface PageResponse<T>

Returns:

the page content/objects as List.

setContent

public void setContent(java.util.List<T> content)

Description copied from interface: PageResponse

Allows to set the content (needed in case of content has to be converted/casted)

Specified by:

setContent in interface PageResponse<T>

Parameters:

content - list of content/objects of this page

getNumber

public int getNumber()

Description copied from interface: PageResponse

Returns the number of the current PageResponse. Is always non-negative.

Specified by:

getNumber in interface PageResponse<T>

Returns:

the number of the current PageResponse.

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: PageResponse

Returns the number of elements currently on this PageResponse.

Specified by:

getNumberOfElements in interface PageResponse<T>

Returns:

the number of elements currently on this PageResponse.

getPageRequest

public PageRequest getPageRequest()

Specified by:

getPageRequest in interface PageResponse<T>

Returns:

the PageRequest used to get this PageResponse

setPageRequest

public void setPageRequest(PageRequest pageRequest)

getSize

public int getSize()

Description copied from interface: PageResponse

Returns the size of the PageResponse.

Specified by:

getSize in interface PageResponse<T>

Returns:

the size of the PageResponse.

getSorting

public Sorting getSorting()

Specified by:

getSorting in interface PageResponse<T>

Returns:

the sorting parameters for the PageResponse.

getTotalElements

public long getTotalElements()

Description copied from interface: PageResponse

Returns the total amount of elements.

Specified by:

getTotalElements in interface PageResponse<T>

Returns:

the total amount of elements

setTotalElements

public void setTotalElements(long totalElements)

getTotalPages

public int getTotalPages()

Description copied from interface: PageResponse

Returns the number of total pages.

Specified by:

getTotalPages in interface PageResponse<T>

Returns:

the number of total pages

hasContent

public boolean hasContent()

Description copied from interface: PageResponse

Returns whether the PageResponse has content at all.

Specified by:

hasContent in interface PageResponse<T>

Returns:

whether the PageResponse has content at all.

hasNext

public boolean hasNext()

Description copied from interface: PageResponse

Returns if there is a next PageResponse.

Specified by:

hasNext in interface PageResponse<T>

Returns:

if there is a next PageResponse.

hasPrevious

public boolean hasPrevious()

Description copied from interface: PageResponse

Returns if there is a previous PageResponse.

Specified by:

hasPrevious in interface PageResponse<T>

Returns:

if there is a previous PageResponse.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isFirst

public boolean isFirst()

Description copied from interface: PageResponse

Returns whether the current PageResponse is the first one.

Specified by:

isFirst in interface PageResponse<T>

Returns:

whether the current PageResponse is the first one.

isLast

public boolean isLast()

Description copied from interface: PageResponse

Returns whether the current PageResponse is the last one.

Specified by:

isLast in interface PageResponse<T>

Returns:

whether the current PageResponse is the last one.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<T>

nextPageRequest

public PageRequest nextPageRequest()

Description copied from interface: PageResponse

Returns the PageRequest to request the next PageResponse. Can be null in case the current PageResponse is already the last one. Clients should check PageResponse.hasNext() before calling this method to make sure they receive a non-null value.

Specified by:

nextPageRequest in interface PageResponse<T>

Returns:

the PageRequest to request the next PageResponse

previousPageRequest

public PageRequest previousPageRequest()

Description copied from interface: PageResponse

Returns the PageRequest to request the previous PageResponse. Can be null in case the current PageResponse is already the first one. Clients should check PageResponse.hasPrevious() before calling this method make sure receive a non-null value.

Specified by:

previousPageRequest in interface PageResponse<T>

Returns:

the PageRequest to request the previous PageResponse

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object