org.apache.commons.collections.functors

Class PredicateTransformer

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: 348444 $ $Date: 2005-11-23 14:06:56 +0000 (Wed, 23 Nov 2005) $

Author: Stephen Colebourne

Constructor Summary
PredicateTransformer(Predicate predicate)
Constructor that performs no validation.
Method Summary
static TransformergetInstance(Predicate predicate)
Factory method that performs validation.
PredicategetPredicate()
Gets the predicate.
Objecttransform(Object input)
Transforms the input to result by calling a predicate.

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

getPredicate

public Predicate getPredicate()
Gets the predicate.

Returns: the predicate

Since: Commons Collections 3.1

transform

public Object transform(Object input)
Transforms the input to result by calling a predicate.

Parameters: input the input object to transform

Returns: the transformed result

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