org.fujion.common

Class CyclicIterator<T>

java.lang.Object

org.fujion.common.CyclicIterator<T>

Type Parameters:

T - The element type.

All Implemented Interfaces:

Iterator<T>

public class CyclicIterator<T>
extends Object
implements Iterator<T>

Generates an iterator that cycles over an underlying iterable (i.e., when it has reached the end of the iteration, it starts over at the beginning).

Constructor Summary

Constructors

Constructor and Description
CyclicIterator(Iterable<T> iterable)
CyclicIterator(T[] array)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() This will always return true unless the wrapped iterable was null or empty.
T	next() Returns the next element in the underlying iteration, cycling to the first element if at the end.
void	reset() Resets the iterator to the first element.

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, remove

Constructor Detail

CyclicIterator

public CyclicIterator(Iterable<T> iterable)

CyclicIterator

public CyclicIterator(T[] array)

Method Detail

hasNext

public boolean hasNext()

This will always return true unless the wrapped iterable was null or empty.

Specified by:

hasNext in interface Iterator<T>

Returns:

True unless the wrapped iterable was null or empty.

next

public T next()

Returns the next element in the underlying iteration, cycling to the first element if at the end.

Specified by:

next in interface Iterator<T>

reset

public void reset()

Resets the iterator to the first element.