net.markenwerk.commons.iterators

Class InfiniteIterator<Payload>

java.lang.Object

net.markenwerk.commons.iterators.AbstractProtectedIterator<Payload>

net.markenwerk.commons.iterators.InfiniteIterator<Payload>

Type Parameters:

Payload - The payload type.

All Implemented Interfaces:

Iterator<Payload>, ProtectedIterator<Payload>

public final class InfiniteIterator<Payload>
extends AbstractProtectedIterator<Payload>

An InfiniteIterator is an AbstractProtectedIterator that infinitely iterates, using a Provider, tom provide further elements.

Since:

3.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
InfiniteIterator(Provider<? extends Payload> provider) Creates a new InfiniteIterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Payload	next() Returns an element provided by the Provider.

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

InfiniteIterator

public InfiniteIterator(Provider<? extends Payload> provider)
                 throws IllegalArgumentException

Creates a new InfiniteIterator.

Parameters:

provider - The Provider to be used.

Throws:

IllegalArgumentException - If the given Provider is null.

Method Detail

hasNext

public boolean hasNext()

next

public Payload next()
             throws ProvisioningException

Returns an element provided by the Provider.

Throws:

ProvisioningException - If the Provider failed to provide an element.