net.digitalid.utility.functional.iterators

Class CyclingIterator<ELEMENT>

java.lang.Object

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

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

All Implemented Interfaces:

Iterator<ELEMENT>

@Mutable
public class CyclingIterator<ELEMENT>
extends ReadOnlyIterator<ELEMENT>

This class implements a cycling iterator that iterates over the elements of the given iterable indefinitely.

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nonnull FiniteIterable<? extends ELEMENT>	iterable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CyclingIterator(@Nonnull FiniteIterable<? extends ELEMENT> iterable)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
ELEMENT	next()
static <ELEMENT> @Nonnull CyclingIterator<ELEMENT>	with(@Nonnull FiniteIterable<? extends ELEMENT> iterable) Returns a new cycling iterator that iterates over the elements of the given iterable indefinitely.

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

iterable

@Nonnull
protected final @Nonnull FiniteIterable<? extends ELEMENT> iterable

Constructor Detail

CyclingIterator

protected CyclingIterator(@Nonnull
                          @Nonnull FiniteIterable<? extends ELEMENT> iterable)

Method Detail

with

@Pure
 @Capturable
 @Nonnull
public static <ELEMENT> @Nonnull CyclingIterator<ELEMENT> with(@Nonnull
                                                                                            @Nonnull FiniteIterable<? extends ELEMENT> iterable)

Returns a new cycling iterator that iterates over the elements of the given iterable indefinitely.

hasNext

@Pure
public boolean hasNext()

Specified by:

hasNext in interface Iterator<ELEMENT>

Specified by:

hasNext in class ReadOnlyIterator<ELEMENT>

next

@Impure
 @NonCapturable
public ELEMENT next()

Specified by:

next in interface Iterator<ELEMENT>

Specified by:

next in class ReadOnlyIterator<ELEMENT>