public abstract class AbstractPage<RequestT,ResponseT,ResourceT,PageT> implements AsyncPage<ResourceT>
Implements
com.google.api.gax.paging.AsyncPage<ResourceT>
Type Parameters
| Name | Description |
| RequestT | |
| ResponseT | |
| ResourceT | |
| PageT | |
Constructors
AbstractPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)
protected AbstractPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)
Parameters
| Name | Description |
| context | PageContext<RequestT,ResponseT,ResourceT>
|
| response | ResponseT
|
Methods
createPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)
protected abstract PageT createPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)
Parameters
| Name | Description |
| context | PageContext<RequestT,ResponseT,ResourceT>
|
| response | ResponseT
|
Returns
createPageAsync(PageContext<RequestT,ResponseT,ResourceT> context, ApiFuture<ResponseT> futureResponse)
public ApiFuture<PageT> createPageAsync(PageContext<RequestT,ResponseT,ResourceT> context, ApiFuture<ResponseT> futureResponse)
Parameters
Returns
getNextPage()
public PageT getNextPage()
Retrieves the next Page object using the next page token, or null if there are no more
pages. The hasNextPage() method can be used to check if a Page object is available.
getNextPage(int pageSize)
public PageT getNextPage(int pageSize)
Parameter
| Name | Description |
| pageSize | int
|
Returns
getNextPageAsync()
public ApiFuture<PageT> getNextPageAsync()
Returns a future for the Page object, retrieved using the next page token. If there are no more
pages, returns a future which will immediately provide null. The hasNextPage() method can be
used to check if a Page object is available.
getNextPageToken()
public String getNextPageToken()
Returns the next page token from the response, or an empty string if there are no more pages.
getPageElementCount()
public int getPageElementCount()
Returns
getRequest()
public RequestT getRequest()
Returns
getResponse()
public ResponseT getResponse()
Returns
getValues()
public Iterable<ResourceT> getValues()
Returns an iterable over the elements in this page.
hasNextPage()
public boolean hasNextPage()
Returns true if there are more pages that can be retrieved from the API.
iterateAll()
public Iterable<ResourceT> iterateAll()
Returns an iterable that traverses all of the elements of the underlying data source. The data
is fetched lazily page by page, where each page may contain multiple elements. A new page is
fetched whenever the elements of any particular page are exhausted.
