io.ably.lib.http

Class PaginatedQuery<T>

java.lang.Object

io.ably.lib.http.PaginatedQuery<T>

Type Parameters:

T - the body response type.

All Implemented Interfaces:

Http.ResponseHandler<PaginatedResult<T>>

public class PaginatedQuery<T>
extends java.lang.Object
implements Http.ResponseHandler<PaginatedResult<T>>

An object that encapsulates parameters of a REST query with a paginated response

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PaginatedQuery.ResultPage A private class encapsulating the result of a single page response

Constructor Summary

Constructors

Constructor and Description
PaginatedQuery(Http http, java.lang.String path, Param[] headers, Param[] params, Http.BodyHandler<T> bodyHandler) Construct a PaginatedQuery

Method Summary

Modifier and Type	Method and Description
PaginatedResult<T>	get() Get the result of the first query
PaginatedQuery.ResultPage	handleResponse(int statusCode, java.lang.String contentType, java.util.Collection<java.lang.String> linkHeaders, byte[] body)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginatedQuery

public PaginatedQuery(Http http,
                      java.lang.String path,
                      Param[] headers,
                      Param[] params,
                      Http.BodyHandler<T> bodyHandler)

Construct a PaginatedQuery

Parameters:

http. - the http instance

path. - the path of the resource being queried

headers. - headers to pass into the first and all relative queries

params. - params to pass into the initial query

bodyHandler. - handler to parse response bodies for first and all relative queries

Method Detail

get

public PaginatedResult<T> get()
                       throws AblyException

Get the result of the first query

Returns:

A PaginatedResult giving the first page of results together with any available links to related results pages.

Throws:

AblyException

handleResponse

public PaginatedQuery.ResultPage handleResponse(int statusCode,
                                                java.lang.String contentType,
                                                java.util.Collection<java.lang.String> linkHeaders,
                                                byte[] body)
                                         throws AblyException

Specified by:

handleResponse in interface Http.ResponseHandler<PaginatedResult<T>>

Throws:

AblyException