Package com.intellij.util.containers

Interface PeekableIterator<T>

All Superinterfaces:

java.util.Iterator<T>

All Known Subinterfaces:

MarkupIterator<T>

All Known Implementing Classes:

FilteringIterator, FilteringMarkupIterator, PeekableIteratorWrapper

public interface PeekableIterator<T>
extends java.util.Iterator<T>

An iterator with additional ability to peek() the current element without moving the cursor.

Field Summary

Fields

Modifier and Type	Field and Description
static PeekableIterator	EMPTY

Method Summary

Modifier and Type	Method and Description
T	peek()

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Field Detail

EMPTY

static final PeekableIterator EMPTY

Method Detail

peek

T peek()
throws java.util.NoSuchElementException

Returns:

the current element. Upon iterator creation should return the first element. After Iterator.hasNext() returned false might throw NoSuchElementException.

Throws:

java.util.NoSuchElementException