org.apache.commons.collections.iterators
Class TransformIterator
java.lang.Object
|
+--org.apache.commons.collections.iterators.ProxyIterator
|
+--org.apache.commons.collections.iterators.TransformIterator
- All Implemented Interfaces:
- Iterator
- public class TransformIterator
- extends ProxyIterator
A Proxy Iterator
which uses a Transformer
instance to
transform the contents of the Iterator
into some other form
- Since:
- 1.0
- Author:
- James Strachan
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
TransformIterator
public TransformIterator()
- Constructs a new
TransformIterator
that will not function
until the setIterator
method is
invoked.
TransformIterator
public TransformIterator(Iterator iterator)
- Constructs a new
TransformIterator
that won't transform
elements from the given iterator.
- Parameters:
iterator
- the iterator to use
TransformIterator
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 usetransformer
- the transformer to use
getTransformer
public Transformer getTransformer()
- Getter for property transformer.
- Returns:
- Value of property transformer.
next
public Object next()
- Description copied from class:
ProxyIterator
- Returns the next element from the underlying iterator.
- Overrides:
next
in class ProxyIterator
- Following copied from class:
org.apache.commons.collections.iterators.ProxyIterator
- Returns:
- the next element from the underlying iterator
- Throws:
NoSuchElementException
- if the underlying iterator
raises it because it has no more elements
setTransformer
public void setTransformer(Transformer transformer)
- Setter for property transformer.
- Parameters:
transformer
- New value of property transformer.
transform
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
Copyright © 2001-2002 Apache Software Foundation. Documenation generated November 10 2002.