public class

TransformIterator

extends Object
implements Iterator<E>
java.lang.Object
   ↳ org.apache.commons.collections.iterators.TransformIterator

Class Overview

Decorates an iterator such that each element returned is transformed.

Summary

Public Constructors
TransformIterator()
Constructs a new TransformIterator that will not function until the setIterator method is invoked.
TransformIterator(Iterator iterator)
Constructs a new TransformIterator that won't transform elements from the given iterator.
TransformIterator(Iterator iterator, Transformer transformer)
Constructs a new TransformIterator that will use the given iterator and transformer.
Public Methods
Iterator getIterator()
Gets the iterator this iterator is using.
Transformer getTransformer()
Gets the transformer this iterator is using.
boolean hasNext()
Object next()
Gets the next object from the iteration, transforming it using the current transformer.
void remove()
void setIterator(Iterator iterator)
Sets the iterator for this iterator to use.
void setTransformer(Transformer transformer)
Sets the transformer this the iterator to use.
Protected Methods
Object transform(Object source)
Transforms the given object using the transformer.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Iterator

Public Constructors

public TransformIterator ()

Constructs a new TransformIterator that will not function until the setIterator method is invoked.

public TransformIterator (Iterator iterator)

Constructs a new TransformIterator that won't transform elements from the given iterator.

Parameters
iterator the iterator to use

public TransformIterator (Iterator iterator, Transformer transformer)

Constructs a new TransformIterator that will use the given iterator and transformer. If the given transformer is null, then objects will not be transformed.

Parameters
iterator the iterator to use
transformer the transformer to use

Public Methods

public Iterator getIterator ()

Gets the iterator this iterator is using.

Returns
  • the iterator.

public Transformer getTransformer ()

Gets the transformer this iterator is using.

Returns
  • the transformer.

public boolean hasNext ()

public Object next ()

Gets the next object from the iteration, transforming it using the current transformer. If the transformer is null, no transformation occurs and the object from the iterator is returned directly.

Returns
  • the next object
Throws
NoSuchElementException if there are no more elements

public void remove ()

public void setIterator (Iterator iterator)

Sets the iterator for this iterator to use. If iteration has started, this effectively resets the iterator.

Parameters
iterator the iterator to use

public void setTransformer (Transformer transformer)

Sets the transformer this the iterator to use. A null transformer is a no-op transformer.

Parameters
transformer the transformer to use

Protected Methods

protected Object transform (Object source)

Transforms the given object using the transformer. If the transformer is null, the original object is returned as-is.

Parameters
source the object to transform
Returns
  • the transformed object