org.apache.commons.functor.core.collection
Class TransformedIterator<E,T>

java.lang.Object
  org.apache.commons.functor.core.collection.TransformedIterator<E,T>

All Implemented Interfaces:

Iterator<T>

public final class TransformedIterator<E,T>
extends Object
implements Iterator<T>

Iterator that transforms another Iterator by applying a UnaryFunction to each returned element.

Version:

$Revision: 1156793 $ $Date: 2011-08-11 22:06:24 +0200 (Thu, 11 Aug 2011) $

Author:

Rodney Waldhoff

Constructor Summary

TransformedIterator(Iterator<? extends E> iterator, UnaryFunction<? super E,? extends T> function)
Create a new TransformedIterator.

Method Summary

boolean	equals(Object obj)
int	hashCode()
boolean	hasNext()
static <E> Iterator<?>	maybeTransform(Iterator<? extends E> iter, UnaryFunction<? super E,?> func) Get an Iterator instance that may be transformed.
T	next()
void	remove()
String	toString()
static <E,T> Iterator<T>	transform(Iterator<? extends E> iter, UnaryFunction<? super E,? extends T> func) Get a Transformed Iterator instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TransformedIterator

public TransformedIterator(Iterator<? extends E> iterator,
                           UnaryFunction<? super E,? extends T> function)

Create a new TransformedIterator.

Parameters:

iterator - Iterator to decorate

function - to apply

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

See Also:

Iterator.hasNext()

next

public T next()

Specified by:

next in interface Iterator<T>

See Also:

Iterator.next()

remove

public void remove()

Specified by:

remove in interface Iterator<T>

See Also:

Iterator.remove()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

transform

public static <E,T> Iterator<T> transform(Iterator<? extends E> iter,
                                          UnaryFunction<? super E,? extends T> func)

Get a Transformed Iterator instance.

Parameters:

iter - to decorate, if null result is null

func - transforming function, cannot be null

Returns:

Iterator

maybeTransform

public static <E> Iterator<?> maybeTransform(Iterator<? extends E> iter,
                                             UnaryFunction<? super E,?> func)

Get an Iterator instance that may be transformed.

Parameters:

iter - to decorate, if null result is null

func - transforming function, if null result is iter

Returns:

Iterator