com.google.api.gax.paging

Class AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>,CollectionT extends AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>>

java.lang.Object

com.google.api.gax.paging.AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>

All Implemented Interfaces:

FixedSizeCollection<ResourceT>

Direct Known Subclasses:

OperationsClient.ListOperationsFixedSizeCollection

public abstract class AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT extends AbstractPage<RequestT,ResponseT,ResourceT,PageT>,CollectionT extends AbstractFixedSizeCollection<RequestT,ResponseT,ResourceT,PageT,CollectionT>>
extends java.lang.Object
implements FixedSizeCollection<ResourceT>

Partial implementation of FixedSizeCollection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFixedSizeCollection(java.util.List<PageT> pages, int collectionSize)

Method Summary

Modifier and Type	Method and Description
protected abstract CollectionT	createCollection(java.util.List<PageT> pages, int collectionSize)
int	getCollectionSize() Returns the number of elements in the collection.
CollectionT	getNextCollection() Retrieves the next FixedSizeCollection using one or more API calls.
java.lang.String	getNextPageToken() Returns a page token that can be passed into the API list method to retrieve additional elements.
java.lang.Iterable<ResourceT>	getValues() Returns an iterable over the elements in this FixedSizeCollection.
boolean	hasNextCollection() Returns true if there are more elements that can be retrieved from the API.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFixedSizeCollection

protected AbstractFixedSizeCollection(java.util.List<PageT> pages,
                                      int collectionSize)

Method Detail

createCollection

protected abstract CollectionT createCollection(java.util.List<PageT> pages,
                                                int collectionSize)

getValues

public java.lang.Iterable<ResourceT> getValues()

Description copied from interface: FixedSizeCollection

Returns an iterable over the elements in this FixedSizeCollection.

Specified by:

getValues in interface FixedSizeCollection<ResourceT>

getNextCollection

public CollectionT getNextCollection()

Description copied from interface: FixedSizeCollection

Retrieves the next FixedSizeCollection using one or more API calls.

Specified by:

getNextCollection in interface FixedSizeCollection<ResourceT>

hasNextCollection

public boolean hasNextCollection()

Description copied from interface: FixedSizeCollection

Returns true if there are more elements that can be retrieved from the API.

Specified by:

hasNextCollection in interface FixedSizeCollection<ResourceT>

getNextPageToken

public java.lang.String getNextPageToken()

Description copied from interface: FixedSizeCollection

Returns a page token that can be passed into the API list method to retrieve additional elements.

Specified by:

getNextPageToken in interface FixedSizeCollection<ResourceT>

getCollectionSize

public int getCollectionSize()

Description copied from interface: FixedSizeCollection

Returns the number of elements in the collection. This will be equal to the collectionSize parameter used at construction unless there are no elements remaining to be retrieved.

Specified by:

getCollectionSize in interface FixedSizeCollection<ResourceT>