com.amazonaws.resources

Interface ResourcePage<T>

Type Parameters:

T - the type of resource contained in this page

All Superinterfaces:

Collection<T>, Iterable<T>, List<T>

public interface ResourcePage<T>
extends List<T>

A page is-a (immutable) List of resources; accessing methods on the list are guaranteed to be purely in-memory operations that will not block or throw exceptions because of transient network issues. A page also knows whether it has a "next page" of resources, and if so knows how to retrieve it (which will almost certainly involve a remote network call that may block or fail).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNextPage() Checks whether this page has a "next page." If this method returns true, the next page can be retrieved by calling next.
ResourcePage<T>	nextPage() Retrieves the next page of results.
ResourcePage<T>	nextPage(ResultCapture<Object> extractor) Retrieves the next page of results, extracting the request id and raw result object into the given context object.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

hasNextPage

boolean hasNextPage()

Checks whether this page has a "next page." If this method returns true, the next page can be retrieved by calling next. If it returns false, any call to next will be guaranteed to throw an IllegalStateException.

Returns:

true if there is a next page of results

nextPage

ResourcePage<T> nextPage()

Retrieves the next page of results.

Returns:

the next page of results

Throws:

IllegalStateException - if there is no next page

AmazonServiceException - on error making the remote call

nextPage

ResourcePage<T> nextPage(ResultCapture<Object> extractor)

Retrieves the next page of results, extracting the request id and raw result object into the given context object.

Parameters:

extractor - a result extractor object

Returns:

the next page of results

Throws:

IllegalStateException - if there is no next page

AmazonServiceException - on error making the remote call