com.google.cloud

Interface Page<T>

Type Parameters:

T - the value type that the page holds

All Known Implementing Classes:

PageImpl

public interface Page<T>

Interface for Google Cloud paginated results.

Use Page to iterate through all values (also in next pages):

 Page<T> page = ...; // get a Page<T> instance
 Iterator<T> iterator = page.iterateAll();
 while (iterator.hasNext()) {
   T value = iterator.next();
   // do something with value
 }

Or handle pagination explicitly:

 Page<T> page = ...; // get a Page<T> instance
 while (page != null) {
   for (T value : page.values()) {
     // do something with value
   }
   page = page.nextPage();
 }

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<T>	iterateAll() Returns an iterator for all values, possibly also in the next pages.
Page<T>	nextPage() Returns the next page of results or null if no more result.
String	nextPageCursor() Returns the cursor for the nextPage or null if no more results.
Iterable<T>	values() Returns the values contained in this page.

Method Detail

values

Iterable<T> values()

Returns the values contained in this page.

iterateAll

Iterator<T> iterateAll()

Returns an iterator for all values, possibly also in the next pages. Once current page's values are traversed the iterator fetches next page, if any.

nextPageCursor

String nextPageCursor()

Returns the cursor for the nextPage or null if no more results.

nextPage

Page<T> nextPage()

Returns the next page of results or null if no more result.