Apache Commons Collections 4.4 · org.apache.commons.collections4.iterators.LoopingIterator

Modifier and Type	Field and Description
private final Collection<? extends E>	collection The collection to base the iterator on
private Iterator<? extends E>	iterator The current iterator

Constructor Summary

Access	Constructor and Description
public	LoopingIterator(final Collection<? extends E> the collection to wrap coll) Constructor that wraps a collection.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if there are more elements hasNext() Implements java.util.Iterator.hasNext. Has the iterator any more elements.
public E	Returns: the next object next() Implements java.util.Iterator.next. Returns the next object in the collection.
public void	remove() Overrides default java.util.Iterator.remove. Removes the previously retrieved item from the underlying collection.
public void	reset() Implements org.apache.commons.collections4.ResettableIterator.reset. Resets the iterator back to the start of the collection.
public int	Returns: the current collection size size() Gets the size of the collection underlying the iterator.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

collection	back to summary
private final Collection<? extends E> collection The collection to base the iterator on

iterator	back to summary
private Iterator<? extends E> iterator The current iterator

Constructor Detail

LoopingIterator	back to summary
public LoopingIterator(final 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. Parameters coll:Collection<? extends E> the collection to wrap Exceptions NullPointerException: if the collection is null

LoopingIterator

back to summary

public LoopingIterator(final 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.

Parameters

coll:Collection<? extends E>: the collection to wrap

Exceptions

NullPointerException:: if the collection is null

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Has the iterator any more elements. Returns false only if the collection originally had zero elements, or all the elements have been `removed`. Returns:boolean `true` if there are more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Has the iterator any more elements.

Returns false only if the collection originally had zero elements, or all the elements have been removed.

Returns:boolean

true if there are more elements

Annotations

@Override

next back to summary

next	back to summary
public E next() Implements java.util.Iterator.next. Returns the next object in the collection. If at the end of the collection, return the first element. Returns:E the next object Annotations @Override Exceptions NoSuchElementException: if there are no elements at all. Use `hasNext` to avoid this error.

public E next()

Implements java.util.Iterator.next.

Returns the next object in the collection.

If at the end of the collection, return the first element.

Returns:E

the next object

Annotations

@Override

Exceptions

NoSuchElementException:: if there are no elements at all. Use hasNext to avoid this error.

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Removes the previously retrieved item from the underlying collection. This feature is only supported if the underlying collection's `iterator` method 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. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Removes the previously retrieved item from the underlying collection.

This feature is only supported if the underlying collection's iterator method 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.

Annotations

@Override

reset	back to summary
public void reset() Implements org.apache.commons.collections4.ResettableIterator.reset. Resets the iterator back to the start of the collection. Annotations @Override

reset

back to summary

public void reset()

Implements org.apache.commons.collections4.ResettableIterator.reset.

Resets the iterator back to the start of the collection.

Annotations