diff --git a/core/src/main/java/org/jclouds/collect/PagedIterable.java b/core/src/main/java/org/jclouds/collect/PagedIterable.java index 738054ea1e..0e1a1a31cb 100644 --- a/core/src/main/java/org/jclouds/collect/PagedIterable.java +++ b/core/src/main/java/org/jclouds/collect/PagedIterable.java @@ -27,31 +27,33 @@ import com.google.common.collect.UnmodifiableIterator; /** * Extends {@link FluentIterable} allowing you to lazily advance through - * sequence of pages in a resultset. Typically used in apis that return only a + * sequence of pages in a result set. Typically used in APIs that return only a * certain number of records at a time. - * - * Simplest usage is to employ the {@link #concat} convenience function, and one - * of the methods from {@link FluentIterable}. - * + *
+ * Simplest usage is to employ the {@link #concat} convenience function, and iterate. + * *- * // pull in new pages until it we see something interesting. - * Optional- * - * For those seeking manual control of page advances, don't use concat, and - * instead look at the value of {@link IterableWithMarker#nextToken}. - * + * + * Another usage is to employ the {@link #concat} convenience function, and one + * of the methods from {@link FluentIterable}. + * *firstInterestingBlob = blobstore - * .list(// options //) - * .concat() - * .firstMatch(isInterestingBlob()); + * FluentIterable extends Image> images = imageApi.listInDetail().concat(); + * + * for (Image image: images) { + * System.out.println(image); + * } *
- * PagedIterator*blobs = blobstore.list(...).iterator(); - * while (blobs.hasNext()) { - * IterableWithMarker page = blobs.next(); - * ProcessedResults results = process(page); - * if (results.shouldBeBookmarked() && page.nextMarker().isPresent()) { - * saveBookmark(page.nextMarker().get()); - * } + * Optional extends Image> image = imageApi.listInDetail().concat().firstMatch(isInterestingImage()); + * System.out.println(image.orNull()); + * ... + * private static Predicate isInterestingImage() { + * return new Predicate () { + * {@literal @}Override + * public boolean apply(Image image) { + * return image.getName().startsWith("Arch"); + * } + * }; * } *