de.unkrig.commons.util.collections

Interface Peekerator<E>

Type Parameters:

E - Der ELement-Typ

All Superinterfaces:

Iterator<E>

All Known Implementing Classes:

StringPeekerator

public interface Peekerator<E>
extends Iterator<E>

Extends the Iterator with the capability to "peek" an element.

See Also:

peek()

Method Summary

Modifier and Type	Method and Description
E	next() Consumes and returns the next element in this iteration.
E	peek() Just like next(), but does not consume the next element.
void	remove() Removes the last element returned by next() or peek() from the underlying collection.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext

Method Detail

next

E next()

Consumes and returns the next element in this iteration.

Specified by:

next in interface Iterator<E>

Returns:

The next element in this iteration

Throws:

NoSuchElementException - This iteration has no more elements

peek

E peek()

Just like next(), but does not consume the next element. I.e. the next invocation of peek() of next() will return the same element that this invocation returns.

Returns:

The next element in this iteration

Throws:

NoSuchElementException - This iteration has no more elements

remove

void remove()

Removes the last element returned by next() or peek() from the underlying collection.

Specified by:

remove in interface Iterator<E>

Throws:

UnsupportedOperationException - This operation is not supported by this peekerator, probably because this peekerator is not backed by a collection

IllegalStateException - The next() or peek() methods have not yet been called

IllegalStateException - The remove() method has already been called after the last call to next() or peek()