org.apache.commons.collections.functors
Class ChainedTransformer

java.lang.Object
  |
  +--org.apache.commons.collections.functors.ChainedTransformer

All Implemented Interfaces:

Serializable, Transformer

public class ChainedTransformer

extends Object

implements Transformer, Serializable

Transformer implementation that chains the specified closures together.

Since:

Commons Collections 3.0

Version:

$Revision: 1.4 $ $Date: 2004/01/14 21:43:09 $

Author:

Stephen Colebourne

See Also:

Serialized Form

Constructor Summary

ChainedTransformer(Transformer[] transformers)
Constructor that performs no validation.

Method Summary

static Transformer	getInstance(Collection transformers) Create a new Transformer that calls each transformer in turn, passing the result into the next transformer.
static Transformer	getInstance(Transformer[] transformers) Factory method that performs validation and copies the parameter array.
static Transformer	getInstance(Transformer transformer1, Transformer transformer2) Factory method that performs validation.
Object	transform(Object object) Execute a list of transformers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainedTransformer

public ChainedTransformer(Transformer[] transformers)

Constructor that performs no validation. Use getInstance if you want that.

Parameters:

transformers - the transformers to chain, not copied, no nulls

Method Detail

getInstance

public static Transformer getInstance(Transformer[] transformers)

Factory method that performs validation and copies the parameter array.

Parameters:

transformers - the transformers to chain, copied, no nulls

Returns:

the chained transformer

Throws:

IllegalArgumentException - if the transformers array is null

IllegalArgumentException - if any transformer in the array is null

getInstance

public static Transformer getInstance(Collection transformers)

Create a new Transformer that calls each transformer in turn, passing the result into the next transformer. The ordering is that of the iterator() method on the collection.

Parameters:

transformers - a collection of transformers to chain

Returns:

the chained transformer

Throws:

IllegalArgumentException - if the transformers collection is null

IllegalArgumentException - if any transformer in the collection is null

getInstance

public static Transformer getInstance(Transformer transformer1,
                                      Transformer transformer2)

Factory method that performs validation.

Parameters:

transformer1 - the first transformer, not null

transformer2 - the second transformer, not null

Returns:

the chained transformer

Throws:

IllegalArgumentException - if either transformer is null

transform

public Object transform(Object object)

Execute a list of transformers.

Specified by:

transform in interface Transformer

Parameters:

object - the input object passed to each transformer

Returns:

a transformed object