net.digitalid.utility.functional.iterators

Class GeneratingIterator<ELEMENT>

java.lang.Object

net.digitalid.utility.functional.iterators.ReadOnlyIterator<ELEMENT>

net.digitalid.utility.functional.iterators.InfiniteIterator<ELEMENT>

net.digitalid.utility.functional.iterators.GeneratingIterator<ELEMENT>

All Implemented Interfaces:

Iterator<ELEMENT>

@Mutable
public class GeneratingIterator<ELEMENT>
extends InfiniteIterator<ELEMENT>

This class implements a generating iterator that generates an infinite number of elements with the given producer.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nonnull FailableProducer<? extends ELEMENT,?>	producer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GeneratingIterator(@Nonnull FailableProducer<? extends ELEMENT,?> producer)

Method Summary

Modifier and Type	Method and Description
ELEMENT	next()
static <ELEMENT> @Nonnull GeneratingIterator<ELEMENT>	with(@Nonnull FailableProducer<? extends ELEMENT,?> producer) Returns a new generating iterator that generates an infinite number of elements with the given producer.

Methods inherited from class net.digitalid.utility.functional.iterators.InfiniteIterator

hasNext

Methods inherited from class net.digitalid.utility.functional.iterators.ReadOnlyIterator

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

Field Detail

producer

@Nonnull
protected final @Nonnull FailableProducer<? extends ELEMENT,?> producer

Constructor Detail

GeneratingIterator

protected GeneratingIterator(@Captured @Nonnull
                             @Nonnull FailableProducer<? extends ELEMENT,?> producer)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <ELEMENT> @Nonnull GeneratingIterator<ELEMENT> with(@Captured @Nonnull
                                                                                               @Nonnull FailableProducer<? extends ELEMENT,?> producer)

Returns a new generating iterator that generates an infinite number of elements with the given producer.

next

@Impure
 @Capturable
public ELEMENT next()

Specified by:

next in interface Iterator<ELEMENT>

Specified by:

next in class ReadOnlyIterator<ELEMENT>