Package com.atlassian.confluence.rest.v2.api.model

Class RestPageRequest

java.lang.Object

com.atlassian.confluence.rest.v2.api.model.RestPageRequest

All Implemented Interfaces:

PageRequest

@ExperimentalApi
public class RestPageRequest
extends Object
implements PageRequest

A request for a page of data. It is a page request that also wraps the URI of the original request, this allows navigational URIs to be built for the next and previous pages.

Since:

9.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURSOR_QPARAM
static final String	LIMIT_QPARAM
static final String	START_QPARAM

Constructor Summary

Constructors

Modifier	Constructor	Description
	RestPageRequest(URI requestUri, int start, int limit)
protected	RestPageRequest(URI requestUri, int start, Cursor cursor, int limit)
	RestPageRequest(URI requestUri, Cursor cursor, int limit)
	RestPageRequest(URI requestUri, PageRequest original)

Method Summary

Modifier and Type	Method	Description
RestPageRequest	copyWithLimits(PageResponse<?> response)
Cursor	getCursor()
int	getLimit()
URI	getRequestUri()
int	getStart()

Methods inherited from class java.lang.Object

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

Field Details

START_QPARAM

public static final String START_QPARAM

See Also:

• Constant Field Values

LIMIT_QPARAM

public static final String LIMIT_QPARAM

See Also:

• Constant Field Values

CURSOR_QPARAM

public static final String CURSOR_QPARAM

See Also:

• Constant Field Values

Constructor Details

RestPageRequest

public RestPageRequest(URI requestUri,
 int start,
 int limit)

Parameters:

requestUri - a URI to be used to produce the self, next and previous links to the resource handling this RestPageRequest

start - zero-based start index for the page of results (first result is 0)

limit - the number of the results to return in the page

Since:

9.4

RestPageRequest

public RestPageRequest(URI requestUri,
 Cursor cursor,
 int limit)

Parameters:

requestUri - a URI to be used to produce the self, next and previous links to the resource handling this RestPageRequest

cursor - the identifier which is used to skip results from a previous query when paginating

limit - the number of the results to return in the page

Since:

9.4

RestPageRequest

protected RestPageRequest(URI requestUri,
 int start,
 Cursor cursor,
 int limit)

Parameters:

requestUri - a URI to be used to produce the self, next and previous links to the resource handling this RestPageRequest

start - zero-based start index for the page of results (first result is 0). This value shouldn't be used when cursor is not null.

cursor - the identifier which is used to skip results from a previous query when paginating. This value shouldn't be used when start > 0. This value must be greater than or equal to 0.

limit - the number of the results to return in the page. This value must be greater than or equal to 0.

Throws:

BadRequestException - when start is greater than 0 and cursor is not null, or when either limit or start are less than 0.

Since:

9.4

RestPageRequest

public RestPageRequest(URI requestUri,
 PageRequest original)

Parameters:

requestUri - a URI to be used to produce the self, next and previous links to the resource handling this RestPageRequest

original - a request which supplies the start and limit fields

Since:

9.4

Method Details

copyWithLimits

public RestPageRequest copyWithLimits(PageResponse<?> response)

getStart

public int getStart()

Specified by:

getStart in interface PageRequest

Returns:

zero-based start index for the page of results (first result is 0)

getLimit

public int getLimit()

Specified by:

getLimit in interface PageRequest

Returns:

the number of the results to return in the page

getCursor

public Cursor getCursor()

Specified by:

getCursor in interface PageRequest

Returns:

the identifier which is used to skip results from a previous query when paginating

getRequestUri

public URI getRequestUri()

Since:

9.4