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(Navigation.Builder navBuilder, int start, int limit)

Deprecated.
since 9.4 use Navigation.Builder.createPageRequest(int, int)

RestPageRequest(Navigation.Builder navBuilder, Cursor cursor, int limit)

Deprecated.
since 9.4 use Navigation.Builder.createPageRequest(Cursor, int)

RestPageRequest(Navigation.Builder navBuilder, PageResponse<Content> response)

Deprecated.
since 9.4 use RestPageRequest(URI, PageRequest)

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)

RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, int start, int limit)

Deprecated.
since 9.4 use RestPageRequest(URI, int, int)

protected

RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, int start, Cursor cursor, int limit)

Deprecated.
since 9.4 use RestPageRequest(URI, int, Cursor, int)

RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, Cursor cursor, int limit)

Deprecated.
since 9.4 use RestPageRequest(URI, Cursor, int)

RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, PageResponse<?> original)

Deprecated.
since 9.4 use RestPageRequest(URI, PageRequest)

RestPageRequest(javax.ws.rs.core.UriInfo requestInfo, int start, int limit)

Deprecated.
since 9.4 use RestPageRequest(URI, int, int)

RestPageRequest(javax.ws.rs.core.UriInfo requestInfo, Cursor cursor, int limit)

Deprecated.
since 9.4 use RestPageRequest(URI, Cursor, int)
Method Summary

Modifier and Type

Method

Description

RestPageRequest

copyWithLimits(PageResponse<?> response)

Cursor

getCursor()

int

getLimit()

URI

getRequestUri()

int

getStart()

javax.ws.rs.core.UriBuilder

getUriBuilder()

Deprecated.
since 9.4 use getRequestUri()

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
  
  @Deprecated public RestPageRequest(javax.ws.rs.core.UriInfo requestInfo, int start, int limit)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, int, int)
  
  Parameters:
  
  requestInfo - request UriInfo 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
- RestPageRequest
  
  @Deprecated public RestPageRequest(javax.ws.rs.core.UriInfo requestInfo, Cursor cursor, int limit)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, Cursor, int)
  
  Parameters:
  
  requestInfo - request UriInfo 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.0
- RestPageRequest
  
  @Deprecated public RestPageRequest(Navigation.Builder navBuilder, int start, int limit)
  
  Deprecated.
  since 9.4 use Navigation.Builder.createPageRequest(int, int)
  
  Parameters:
  
  navBuilder - a Navigation.Builder 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
- RestPageRequest
  
  @Deprecated public RestPageRequest(Navigation.Builder navBuilder, Cursor cursor, int limit)
  
  Deprecated.
  since 9.4 use Navigation.Builder.createPageRequest(Cursor, int)
  
  Parameters:
  
  navBuilder - a Navigation.Builder 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.0
- RestPageRequest
  
  @Deprecated public RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, int start, int limit)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, int, int)
  
  Parameters:
  
  requestUri - a uriBuilder 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
- 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
  
  @Deprecated public RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, Cursor cursor, int limit)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, Cursor, int)
  
  Parameters:
  
  requestUri - a uriBuilder 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.0
- 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
  
  @Deprecated protected RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, int start, Cursor cursor, int limit)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, int, Cursor, int)
  
  Parameters:
  
  requestUri - a uriBuilder 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.
- 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
  
  @Deprecated public RestPageRequest(Navigation.Builder navBuilder, PageResponse<Content> response)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, PageRequest)
  
  Parameters:
  
  navBuilder - a Navigation.Builder to be used to produce the self, next and previous links to the resource handling this RestPageRequest
  
  response - a response whose PageRequest supplies the start and limit fields
- 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
- RestPageRequest
  
  @Deprecated public RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, PageResponse<?> original)
  
  Deprecated.
  since 9.4 use RestPageRequest(URI, PageRequest)
  
  Parameters:
  
  requestUri - a uriBuilder 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
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
- getUriBuilder
  
  @Deprecated public javax.ws.rs.core.UriBuilder getUriBuilder()
  
  Deprecated.
  since 9.4 use getRequestUri()

Class RestPageRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

START_QPARAM

LIMIT_QPARAM

CURSOR_QPARAM

Constructor Details

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

RestPageRequest

Method Details

copyWithLimits

getStart

getLimit

getCursor

getRequestUri

getUriBuilder