org.jclouds.openstack.v2_0.domain

Class PaginatedCollection<T>

java.lang.Object

com.google.common.collect.FluentIterable<T>

org.jclouds.collect.IterableWithMarker<T>

org.jclouds.openstack.v2_0.domain.PaginatedCollection<T>

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

FirewallPolicies, FirewallRules, Firewalls, FloatingIPs, HealthMonitors, Members, MessageStream, Networks, Pools, Ports, Queues, Routers, Rules, SecurityGroups, Subnets, VIPs

public class PaginatedCollection<T>
extends IterableWithMarker<T>

Base class for a paginated collection in OpenStack.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PaginatedCollection(Iterable<T> resources, Iterable<Link> links)
protected	PaginatedCollection(Iterable<T> resources, Iterable<Link> links, Integer totalEntries)

Method Summary

Modifier and Type	Method and Description
Iterable<Link>	getLinks() links that relate to this collection
com.google.common.base.Optional<Integer>	getTotalEntries()
Iterator<T>	iterator()
com.google.common.base.Optional<Object>	nextMarker() If there is a next marker, then the set is incomplete and you should issue another command to retrieve the rest, setting the option marker to this value
PaginationOptions	nextPaginationOptions()

Methods inherited from class com.google.common.collect.FluentIterable

allMatch, anyMatch, append, append, concat, concat, concat, concat, concat, contains, copyInto, cycle, filter, filter, first, firstMatch, from, from, from, get, index, isEmpty, join, last, limit, of, of, size, skip, stream, toArray, toList, toMap, toMultiset, toSet, toSortedList, toSortedSet, toString, transform, transformAndConcat, uniqueIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PaginatedCollection

protected PaginatedCollection(@Nullable
                              Iterable<T> resources,
                              @Nullable
                              Iterable<Link> links,
                              @Nullable
                              Integer totalEntries)

PaginatedCollection

protected PaginatedCollection(Iterable<T> resources,
                              Iterable<Link> links)

Method Detail

iterator

public Iterator<T> iterator()

getLinks

public Iterable<Link> getLinks()

links that relate to this collection

getTotalEntries

public com.google.common.base.Optional<Integer> getTotalEntries()

Returns:

The total number of entries in this collection, if that information is present.

nextPaginationOptions

public PaginationOptions nextPaginationOptions()

nextMarker

public com.google.common.base.Optional<Object> nextMarker()

Description copied from class: IterableWithMarker

If there is a next marker, then the set is incomplete and you should issue another command to retrieve the rest, setting the option marker to this value

Specified by:

nextMarker in class IterableWithMarker<T>

Returns:

next marker, or absent if list is complete