org.codefx.libfx.collection.transform

Class TransformingIterator<I,O>

java.lang.Object

org.codefx.libfx.collection.transform.TransformingIterator<I,O>

Type Parameters:

I - the inner type, i.e. the type of the elements returned by the wrapped/inner iterator

O - the outer type, i.e. the type of elements returned by this iterator

All Implemented Interfaces:

Iterator<O>

public final class TransformingIterator<I,O>
extends Object

An Iterator which wraps another iterator and transforms the returned elements from their inner type I to an outer type O.

The transformation of null elements is fixed to null -> null. The transformation function specified during construction does not have to handle null input elements and is not allowed to produce a null result.

Constructor Summary

Constructors

Constructor and Description
TransformingIterator(Iterator<? extends I> innerIterator, Function<? super I,? extends O> transformToOuter) Creates a new iterator.

Method Summary

Modifier and Type	Method and Description
void	forEachRemaining(Consumer<? super O> action)
protected Iterator<? extends I>	getInnerIterator()
boolean	hasNext()
O	next()
void	remove()
protected O	transformToOuter(I innerElement) Transforms an element from the inner type I to the outer type O.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformingIterator

public TransformingIterator(Iterator<? extends I> innerIterator,
                            Function<? super I,? extends O> transformToOuter)

Creates a new iterator.

If the specified iterator is used by any other instance, the behavior is undefined. The specified transform function will not be called with null elements and is not allowed to return null.

Parameters:

innerIterator - the wrapped/inner iterator

transformToOuter - transforms elements from the inner type I to the outer type O

Method Detail

getInnerIterator

protected Iterator<? extends I> getInnerIterator()

Returns:

the wrapped/inner iterator

transformToOuter

protected O transformToOuter(I innerElement)

Transforms an element from the inner type I to the outer type O.

Parameters:

innerElement - an element returned by the innerIterator

Returns:

an equivalent element of type O

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<O>

next

public O next()

Specified by:

next in interface Iterator<O>

remove

public void remove()

Specified by:

remove in interface Iterator<O>

forEachRemaining

public void forEachRemaining(Consumer<? super O> action)

Specified by:

forEachRemaining in interface Iterator<O>