org.apache.commons.collections.functors
Class PredicateTransformer

java.lang.Object
  |
  +--org.apache.commons.collections.functors.PredicateTransformer
All Implemented Interfaces:
Serializable, Transformer

public class PredicateTransformer
extends Object
implements Transformer, Serializable

Transformer implementation that calls a Predicate using the input object and then returns the input.

Since:
Commons Collections 3.0
Version:
$Revision: 1.2 $ $Date: 2004/01/14 21:43:09 $
Author:
Stephen Colebourne
See Also:
Serialized Form

Constructor Summary
PredicateTransformer(Predicate predicate)
          Constructor that performs no validation.
 
Method Summary
static Transformer getInstance(Predicate predicate)
          Factory method that performs validation.
 Object transform(Object input)
          Call the predicate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PredicateTransformer

public PredicateTransformer(Predicate predicate)
Constructor that performs no validation. Use getInstance if you want that.
Parameters:
predicate - the predicate to call, not null
Method Detail

getInstance

public static Transformer getInstance(Predicate predicate)
Factory method that performs validation.
Parameters:
predicate - the predicate to call, not null
Returns:
the predicate transformer
Throws:
IllegalArgumentException - if the predicate is null

transform

public Object transform(Object input)
Call the predicate.
Specified by:
transform in interface Transformer
Following copied from interface: org.apache.commons.collections.Transformer
Parameters:
input - the object to be transformed
Returns:
a transformed object
Throws:
ClassCastException - (runtime) if the input is the wrong class
IllegalArgumentException - (runtime) if the input is invalid
FunctorException - (runtime) if the transform cannot be completed


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.