com.gooddata.collections

Class PageRequest

java.lang.Object

com.gooddata.collections.PageRequest

All Implemented Interfaces:

Page

public class PageRequest
extends Object
implements Page

User defined page with desired offset and limit.

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	DEFAULT_LIMIT

Constructor Summary

Constructors

Constructor and Description
PageRequest() Creates new page definition with default values
PageRequest(int limit) Creates new page definition with limit and no offset (usually for the first page)
PageRequest(int offset, int limit) Creates new page definition with provided values.
PageRequest(String offset, int limit) Creates new page definition with provided values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getLimit()
String	getOffset()
URI	getPageUri(org.springframework.web.util.UriComponentsBuilder uriBuilder) Creates URI for this page request.
int	getSanitizedLimit()
int	hashCode()
void	setLimit(int limit)
void	setOffset(String offset)
org.springframework.web.util.UriComponentsBuilder	updateWithPageParams(org.springframework.web.util.UriComponentsBuilder uriBuilder) Updates provided URI builder query params according to this page configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIMIT

public static final Integer DEFAULT_LIMIT

Constructor Detail

PageRequest

public PageRequest()

Creates new page definition with default values

PageRequest

public PageRequest(int offset,
                   int limit)

Creates new page definition with provided values.

Parameters:

offset - page offset (position in the collection)

limit - maximal number of returned elements (on a page)

PageRequest

public PageRequest(String offset,
                   int limit)

Creates new page definition with provided values.

Parameters:

offset - page offset (position in the collection)

limit - maximal number of returned elements (on a page)

PageRequest

public PageRequest(int limit)

Creates new page definition with limit and no offset (usually for the first page)

Parameters:

limit - maximal number of returned elements (on a page)

Method Detail

getOffset

public String getOffset()

setOffset

public void setOffset(String offset)

getLimit

public int getLimit()

getSanitizedLimit

public int getSanitizedLimit()

setLimit

public void setLimit(int limit)

getPageUri

public URI getPageUri(org.springframework.web.util.UriComponentsBuilder uriBuilder)

Description copied from interface: Page

Creates URI for this page request.

Use Page.updateWithPageParams(UriComponentsBuilder) if you have URI template and only want to update it with page query params.

Specified by:

getPageUri in interface Page

Parameters:

uriBuilder - URI builder used for generating page URI

Returns:

compiled page URI

updateWithPageParams

public org.springframework.web.util.UriComponentsBuilder updateWithPageParams(org.springframework.web.util.UriComponentsBuilder uriBuilder)

Description copied from interface: Page

Updates provided URI builder query params according to this page configuration.

As Page.getPageUri(UriComponentsBuilder) returns expanded page URI it is not very useful for cases that require use of URI template with URI variables. This method allows you to use URI templates and benefit from pagination support implemented in Page implementations. It is especially useful if you need to handle multiple requests of the same URI template in the same way - e.g. monitor request made by RestOperations methods.

Use this in the situation when you have URI template with placeholders and URI variables separately. This method is useful when you have URI template with placeholders and only want to add query parameters based on this page to it.

Use Page.getPageUri(UriComponentsBuilder) if you want to get concrete page URI and don't have URI template.

Specified by:

updateWithPageParams in interface Page

Parameters:

uriBuilder - URI builder used for constructing page URI

Returns:

provided and updated builder instance

See Also:

RestOperations

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object