public class LoopingIterator<E> extends Object implements ResettableIterator<E>An Iterator that restarts when it reaches the end.
The iterator will loop continuously around the provided elements, unless there are no elements in the collection to begin with, or all the elements have been
Concurrent modifications are not directly supported, and for most collection implementations will throw a ConcurrentModificationException.
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
hasNext()Has the iterator any more elements.
next()Returns the next object in the collection.
remove()Removes the previously retrieved item from the underlying collection.
reset()Resets the iterator back to the start of the collection.
size()Gets the size of the collection underlying the iterator.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public LoopingIterator(Collection<? extends E> coll)Constructor that wraps a collection.
There is no way to reset an Iterator instance without recreating it from the original source, so the Collection must be passed in.
coll- the collection to wrap
NullPointerException- if the collection is null
public boolean hasNext()Has the iterator any more elements.
Returns false only if the collection originally had zero elements, or all the elements have been
public E next()Returns the next object in the collection.
If at the end of the collection, return the first element.
public void remove()Removes the previously retrieved item from the underlying collection.
This feature is only supported if the underlying collection's
iteratormethod returns an implementation that supports it.
This method can only be called after at least one
next()method call. After a removal, the remove method may not be called again until another next has been performed. If the
reset()is called, then remove may not be called until
next()is called again.
public void reset()Resets the iterator back to the start of the collection.
public int size()Gets the size of the collection underlying the iterator.
- the current collection size