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

java.lang.Object
  extended by com.atlassian.confluence.rest.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 UriInfo of the original request, this allows navigational URIs to be built for the next and previous pages.


Field Summary
static String LIMIT_QPARAM
           
static String START_QPARAM
           
 
Constructor Summary
RestPageRequest(Navigation.Builder navBuilder, int start, int limit)
           
RestPageRequest(Navigation.Builder navBuilder, PageResponse<Content> pageResponse)
           
RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, int start, int limit)
           
RestPageRequest(javax.ws.rs.core.UriBuilder requestUri, PageResponse response)
           
RestPageRequest(javax.ws.rs.core.UriInfo requestInfo, int start, int limit)
           
 
Method Summary
 RestPageRequest copyWithLimits(PageResponse response)
           
 int getLimit()
           
 int getStart()
           
 javax.ws.rs.core.UriBuilder getUriBuilder()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

START_QPARAM

public static String START_QPARAM

LIMIT_QPARAM

public static String LIMIT_QPARAM
Constructor Detail

RestPageRequest

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

RestPageRequest

public RestPageRequest(Navigation.Builder navBuilder,
                       int start,
                       int limit)

RestPageRequest

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

RestPageRequest

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

RestPageRequest

public RestPageRequest(javax.ws.rs.core.UriBuilder requestUri,
                       PageResponse response)
Method Detail

copyWithLimits

public RestPageRequest copyWithLimits(PageResponse response)

getStart

public int getStart()
Specified by:
getStart in interface PageRequest
Returns:
start index for the page of results

getLimit

public int getLimit()
Specified by:
getLimit in interface PageRequest
Returns:
the number of the results to return in the page

getUriBuilder

public javax.ws.rs.core.UriBuilder getUriBuilder()


Copyright © 2003–2015 Atlassian. All rights reserved.