de.larssh.utils.collection

Interface PeekableIterator<E>

Type Parameters:

E - the type of elements returned by this iterator

All Superinterfaces:

Iterator<E>

public interface PeekableIterator<E>
extends Iterator<E>

An iterator that allows peeking up to one element without removing it, supporting a one-element lookahead while iterating.

Method Summary

Modifier and Type	Method and Description
E	peek() Returns the next element in the iteration without removing it from the elements returned by Iterator.next().
default E	peekNonNull() Returns the next element in the iteration without removing it from the elements returned by Iterator.next().

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

peek

@Nullable
E peek()

Returns the next element in the iteration without removing it from the elements returned by Iterator.next().

Use peekNonNull() if the iterator is proven not to contain null.

Returns:

the next element in the iteration

Throws:

NoSuchElementException - if the iteration has no more elements

peekNonNull

default E peekNonNull()

Returns the next element in the iteration without removing it from the elements returned by Iterator.next().

Returns:

the next element in the iteration

Throws:

NoSuchElementException - if the iteration has no more elements

NullPointerException - if the peeked element is null