com.amazonaws.resources

Interface ResourceCollection<T>

Type Parameters:

T - the type of resource contained in this collection

All Superinterfaces:

Iterable<T>

All Known Subinterfaces:

AccessKeyCollection, AccountAliasCollection, DhcpOptionsCollection, GroupCollection, GroupPolicyCollection, ImageCollection, InstanceCollection, InstanceProfileCollection, InternetGatewayCollection, JobCollection, KeyPairCollection, MfaDeviceCollection, MultipartUploadCollection, NetworkAclCollection, NetworkInterfaceCollection, PlacementGroupCollection, PlatformApplicationCollection, PlatformEndpointCollection, QueueCollection, RoleCollection, RolePolicyCollection, RouteTableAssociationCollection, RouteTableCollection, SamlProviderCollection, SecurityGroupCollection, ServerCertificateCollection, SigningCertificateCollection, SnapshotCollection, SubnetCollection, SubscriptionCollection, TopicCollection, UserCollection, UserPolicyCollection, VaultCollection, VirtualMfaDeviceCollection, VolumeCollection, VpcCollection, VpcPeeringConnectionCollection

public interface ResourceCollection<T>
extends Iterable<T>

A collection of resources.

Method Summary

Methods

Modifier and Type	Method and Description
ResourcePage<T>	firstPage() Makes exactly one service call to retrieve the first page of results from this collection.
ResourcePage<T>	firstPage(ResultCapture<Object> extractor) Makes exactly one service call to retrieve the first page of results from this collection.
Iterator<T>	iterator() Returns an Iterator which will lazily paginate through the entire collection, potentially making multiple service calls as the iterator is used.
Iterable<ResourcePage<T>>	pages() Returns a view of this collection as a set of pages rather than a set of resources.

Method Detail

iterator

Iterator<T> iterator()

Returns an Iterator which will lazily paginate through the entire collection, potentially making multiple service calls as the iterator is used.

This method will not block or throw an exception, but calls to hasNext and next on the returned Iterator may.

The code:

 for (T resource : collection) {
     handle(resource);
 }
 

Is precisely equivalent to:

 for (ResourcePage page : collection.pages()) {
     for (T resource : page) {
         handle(resource);
     }
 }
 

Specified by:

iterator in interface Iterable<T>

Returns:

a lazy Iterator of the resources in this collection

pages

Iterable<ResourcePage<T>> pages()

Returns a view of this collection as a set of pages rather than a set of resources. While iterating through this view, each call to Iterator.next() will make exactly one call to the service and return the full page of results.

 for (ResourcePage page : collection.pages()) {
     System.out.println("Got " + page.size() + " results.");
 }
 

Returns:

an Iterable collection of resource pages

firstPage

ResourcePage<T> firstPage()

Makes exactly one service call to retrieve the first page of results from this collection. Further pages may be retrieved by invoking ResourcePage.nextPage() on the returned value.

Returns:

the first page of resources in this collection

firstPage

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

Makes exactly one service call to retrieve the first page of results from this collection. Further pages may be retrieved by invoking ResourcePage.nextPage() on the returned value. Also extracts the request id and raw client-level result object for examination.

Parameters:

extractor - a result extractor object

Returns:

the first page of resources in this collection