com.abiquo.apiclient.domain

Class PageIterator<T extends com.abiquo.model.transport.WrapperDto<? extends com.abiquo.model.transport.SingleResourceTransportDto>>

java.lang.Object

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

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

com.abiquo.apiclient.domain.PageIterator<T>

All Implemented Interfaces:

Iterator<T>

public class PageIterator<T extends com.abiquo.model.transport.WrapperDto<? extends com.abiquo.model.transport.SingleResourceTransportDto>>
extends com.google.common.collect.AbstractIterator<T>

An Iterator that is capable of advancing between the pages of a paginated collection.

To create this iterator use the #flatten(ApiClient, WrapperDto) method.

Author:

Ignasi Barrera

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageIterator.AdvancingIterable<T extends com.abiquo.model.transport.SingleResourceTransportDto,W extends com.abiquo.model.transport.WrapperDto<T>> An Iterable that is capable of advancing between pages.

Method Summary

Methods

Modifier and Type	Method and Description
protected T	computeNext()
static <T extends com.abiquo.model.transport.SingleResourceTransportDto,W extends com.abiquo.model.transport.WrapperDto<T>> Iterable<T>	flatten(RestClient api, W dto) Creates an iterator capable of advancing over the elements of a paginated collection, and lazily fetch new pages as they are needed.

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

endOfData, hasNext, next, peek

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

remove

Methods inherited from class java.lang.Object

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

Method Detail

computeNext

protected T computeNext()

Specified by:

computeNext in class com.google.common.collect.AbstractIterator<T extends com.abiquo.model.transport.WrapperDto<? extends com.abiquo.model.transport.SingleResourceTransportDto>>

flatten

public static <T extends com.abiquo.model.transport.SingleResourceTransportDto,W extends com.abiquo.model.transport.WrapperDto<T>> Iterable<T> flatten(RestClient api,
                                                                                                                                       W dto)

Creates an iterator capable of advancing over the elements of a paginated collection, and lazily fetch new pages as they are needed.

Parameters:

api - The rest client used to fetch new pages when needed.

dto - The collection to iterate.

Returns:

An iterator capable of advancing between pages.