org.springframework.hateoas

Class PagedResources.PageMetadata

java.lang.Object

org.springframework.hateoas.PagedResources.PageMetadata

Enclosing class:

PagedResources<T>

public static class PagedResources.PageMetadata
extends Object

Value object for pagination metadata.

Author:

Oliver Gierke

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PageMetadata()
	PageMetadata(long size, long number, long totalElements) Creates a new PagedResources.PageMetadata from the given size, numer and total elements.
	PageMetadata(long size, long number, long totalElements, long totalPages) Creates a new PagedResources.PageMetadata from the given size, number, total elements and total pages.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getNumber() Returns the number of the current page.
long	getSize() Returns the requested size of the page.
long	getTotalElements() Returns the total number of elements available.
long	getTotalPages() Returns how many pages are available in total.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PageMetadata

protected PageMetadata()

PageMetadata

public PageMetadata(long size,
                    long number,
                    long totalElements,
                    long totalPages)

Creates a new PagedResources.PageMetadata from the given size, number, total elements and total pages.

Parameters:

size -

number - zero-indexed, must be less than totalPages

totalElements -

totalPages -

PageMetadata

public PageMetadata(long size,
                    long number,
                    long totalElements)

Creates a new PagedResources.PageMetadata from the given size, numer and total elements.

Parameters:

size - the size of the page

number - the number of the page

totalElements - the total number of elements available

Method Detail

getSize

public long getSize()

Returns the requested size of the page.

Returns:

the size a positive long.

getTotalElements

public long getTotalElements()

Returns the total number of elements available.

Returns:

the totalElements a positive long.

getTotalPages

public long getTotalPages()

Returns how many pages are available in total.

Returns:

the totalPages a positive long.

getNumber

public long getNumber()

Returns the number of the current page.

Returns:

the number a positive long.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object