com.google.cloud

Class PageImpl<T>

java.lang.Object

com.google.cloud.PageImpl<T>

Type Parameters:

T - the value type that the page holds

All Implemented Interfaces:

Page<T>, Serializable

public class PageImpl<T>
extends Object
implements Page<T>, Serializable

Base implementation for Google Cloud paginated results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PageImpl.NextPageFetcher<T> Interface for fetching the next page of results from the service.

Constructor Summary

Constructors

Constructor and Description
PageImpl(PageImpl.NextPageFetcher<T> pageFetcher, String cursor, Iterable<T> results) Creates a PageImpl object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
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.
static <T> Map<T,Object>	nextRequestOptions(T pageTokenOption, String cursor, Map<T,?> optionMap) Utility method to construct the options map for the next page request.
Iterable<T>	values() Returns the values contained in this page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageImpl

public PageImpl(PageImpl.NextPageFetcher<T> pageFetcher,
        String cursor,
        Iterable<T> results)

Creates a PageImpl object. In order for the object to be serializable the results parameter must be serializable.

Method Detail

values

public Iterable<T> values()

Description copied from interface: Page

Returns the values contained in this page.

Specified by:

values in interface Page<T>

iterateAll

public Iterator<T> iterateAll()

Description copied from interface: Page

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.

Specified by:

iterateAll in interface Page<T>

nextPageCursor

public String nextPageCursor()

Description copied from interface: Page

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

Specified by:

nextPageCursor in interface Page<T>

nextPage

public Page<T> nextPage()

Description copied from interface: Page

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

Specified by:

nextPage in interface Page<T>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

nextRequestOptions

public static <T> Map<T,Object> nextRequestOptions(T pageTokenOption,
                                   String cursor,
                                   Map<T,?> optionMap)

Utility method to construct the options map for the next page request.

Type Parameters:

T - the value type that the page holds. Instances of T should be Serializable

Parameters:

pageTokenOption - the key for the next page cursor option in the options map

cursor - the cursor for the next page

optionMap - the previous options map

Returns:

the options map for the next page request