Package org.javimmutable.collections.iterators

Class TransformIterator<S,T>

java.lang.Object

org.javimmutable.collections.iterators.AbstractSplitableIterator<T>

org.javimmutable.collections.iterators.TransformIterator<S,T>

All Implemented Interfaces:

Iterator<T>, SplitableIterator<T>

@Immutable
public class TransformIterator<S,T>
extends AbstractSplitableIterator<T>

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
boolean	isSplitAllowed()	Tests to determine if this Iterator is capable of splitting into two new Iterators.
T	next()
static <S, T> TransformIterator<S,T>	of(SplitableIterator<S> source, java.util.function.Function<S,T> transforminator)
SplitIterator<T>	splitIterator()	Whenever isSplitAllowed returns true this method can be used to create two new SplitableIterators that collectively visit all the same elements as this Iterator.

Methods inherited from class org.javimmutable.collections.iterators.AbstractSplitableIterator

spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Method Details

of

public static <S,
T> TransformIterator<S,T> of(@Nonnull
 SplitableIterator<S> source,
 @Nonnull
 java.util.function.Function<S,T> transforminator)

hasNext

public boolean hasNext()

next

public T next()

isSplitAllowed

public boolean isSplitAllowed()

Description copied from interface: SplitableIterator

Tests to determine if this Iterator is capable of splitting into two new Iterators.

splitIterator

@Nonnull
public SplitIterator<T> splitIterator()

Description copied from interface: SplitableIterator

Whenever isSplitAllowed returns true this method can be used to create two new SplitableIterators that collectively visit all the same elements as this Iterator. Whenever isSplitAllowed returns false this method throws UnsupportedOperationException.

Returns:

two new SplitableIterators spanning the same elements as this