Package com.google.common.collect
Interface PeekingIterator<E extends @Nullable java.lang.Object>
-
- All Superinterfaces:
java.util.Iterator<E>
@DoNotMock("Use Iterators.peekingIterator") @GwtCompatible public interface PeekingIterator<E extends @Nullable java.lang.Object> extends java.util.Iterator<E>
An iterator that supports a one-element lookahead while iterating.See the Guava User Guide article on
PeekingIterator
.- Since:
- 2.0
- Author:
- Mick Killianey
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description E
next()
E
peek()
Returns the next element in the iteration, without advancing the iteration.void
remove()
-
-
-
Method Detail
-
peek
E peek()
Returns the next element in the iteration, without advancing the iteration.Calls to
peek()
should not change the state of the iteration, except that it may prevent removal of the most recent element viaremove()
.- Throws:
java.util.NoSuchElementException
- if the iteration has no more elements according toIterator.hasNext()
-
next
@CanIgnoreReturnValue E next()
-
remove
void remove()
-
-