Package com.intellij.util.containers

Class JBIterator<E>

java.lang.Object

com.intellij.util.containers.JBIterator<E>

All Implemented Interfaces:

java.util.Iterator<E>

Direct Known Subclasses:

TreeTraversal.It

public abstract class JBIterator<E>
extends java.lang.Object
implements java.util.Iterator<E>

Iterator that accumulates transformations and filters keeping its instance. So JBIterable#filter() and JBIterable#transform() preserve the underlying iterator API.

Supported contracts:

• Classic iterator: hasNext() / next()
• Cursor: advance() / current()
• One-time iterable: cursor()

Implementors should provide nextImpl() method which can call stop()/skip().

See Also:

JBIterable.map(Function), JBIterable.filter(Condition), TreeTraversal.TracingIt

Constructor Summary

Constructors

Constructor and Description
JBIterator()

Method Summary

Modifier and Type	Method and Description
boolean	advance() Proceeds to the next element if any and returns true; otherwise false.
E	current() Returns the current element if any; otherwise throws exception.
protected void	currentChanged() Called right after the new current value is set.
static <E extends JBIterator<?>> JBIterable<E>	cursor(E iterator)
JBIterator<E>	filter(Condition<? super E> condition)
<T> JBIterator<T>	filterMap(Function<? super E,? extends T> function)
static <E> JBIterator<E>	from(java.util.Iterator<? extends E> it)
JBIterable<Function<java.lang.Object,java.lang.Object>>	getTransformations()
boolean	hasNext()
<T> JBIterator<T>	map(Function<? super E,? extends T> function)
E	next()
protected abstract E	nextImpl() Returns the next element if any; otherwise calls stop() or skip().
void	remove()
protected E	skip() Notifies the iterator to skip and re-invoke nextImpl().
JBIterator<E>	skip(int count)
JBIterator<E>	skipWhile(Condition<? super E> condition)
protected E	stop() Notifies the iterator that there's no more elements.
JBIterator<E>	take(int count)
JBIterator<E>	takeWhile(Condition<? super E> condition)
java.util.List<E>	toList()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

JBIterator

public JBIterator()

Method Detail

cursor

public static <E extends JBIterator<?>> JBIterable<E> cursor(E iterator)

from

public static <E> JBIterator<E> from(java.util.Iterator<? extends E> it)

nextImpl

protected abstract E nextImpl()

Returns the next element if any; otherwise calls stop() or skip().

currentChanged

protected void currentChanged()

Called right after the new current value is set.

stop

protected final E stop()

Notifies the iterator that there's no more elements.

skip

protected final E skip()

Notifies the iterator to skip and re-invoke nextImpl().

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

next

public final E next()

Specified by:

next in interface java.util.Iterator<E>

advance

public final boolean advance()

Proceeds to the next element if any and returns true; otherwise false.

current

public final E current()

Returns the current element if any; otherwise throws exception.

map

public final <T> JBIterator<T> map(Function<? super E,? extends T> function)

filter

public final JBIterator<E> filter(Condition<? super E> condition)

filterMap

public final <T> JBIterator<T> filterMap(Function<? super E,? extends T> function)

take

public final JBIterator<E> take(int count)

takeWhile

public final JBIterator<E> takeWhile(Condition<? super E> condition)

skip

public final JBIterator<E> skip(int count)

skipWhile

public final JBIterator<E> skipWhile(Condition<? super E> condition)

remove

public final void remove()

Specified by:

remove in interface java.util.Iterator<E>

toList

public final java.util.List<E> toList()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTransformations

public final JBIterable<Function<java.lang.Object,java.lang.Object>> getTransformations()