org.jclouds.atmos.options
Class ListOptions

java.lang.Object
  extended by org.jclouds.http.options.BaseHttpRequestOptions
      extended by org.jclouds.atmos.options.ListOptions
All Implemented Interfaces:
HttpRequestOptions

public class ListOptions
extends BaseHttpRequestOptions

Options used to control paginated results (aka list commands).

Author:
Adrian Cole

Nested Class Summary
static class ListOptions.Builder
           
 
Field Summary
static ListOptions NONE
           
 
Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters
 
Constructor Summary
ListOptions()
           
 
Method Summary
 Integer getLimit()
           
 String getToken()
           
 ListOptions includeMeta()
          the maximum number of items that should be returned.
 ListOptions limit(int maxresults)
          the maximum number of items that should be returned.
 boolean metaIncluded()
           
 ListOptions token(String token)
          specifies the position to resume listing

note this is an opaque value and should not be interpreted.

 
Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions
buildFormParameters, buildMatrixParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstMatrixOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NONE

public static final ListOptions NONE
Constructor Detail

ListOptions

public ListOptions()
Method Detail

token

public ListOptions token(String token)
specifies the position to resume listing

note this is an opaque value and should not be interpreted.


getToken

public String getToken()

limit

public ListOptions limit(int maxresults)
the maximum number of items that should be returned. If this is not specified, there is no limit.


includeMeta

public ListOptions includeMeta()
the maximum number of items that should be returned. If this is not specified, there is no limit.


metaIncluded

public boolean metaIncluded()

getLimit

public Integer getLimit()


Copyright © 2009-2012 jclouds. All Rights Reserved.