org.apache.commons.collections.functors
Class PredicateTransformer

java.lang.Object
  org.apache.commons.collections.functors.PredicateTransformer

All Implemented Interfaces:

java.io.Serializable, Transformer

public class PredicateTransformer
extends java.lang.Object
implements Transformer, java.io.Serializable

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

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 13:33:15 +0100 (Thu, 10 Apr 2008) $

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.
Predicate	getPredicate() Gets the predicate.
java.lang.Object	transform(java.lang.Object input) Transforms the input to result by calling a 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:

java.lang.IllegalArgumentException - if the predicate is null

transform

public java.lang.Object transform(java.lang.Object input)

Transforms the input to result by calling a predicate.

Specified by:

transform in interface Transformer

Parameters:

input - the input object to transform

Returns:

the transformed result

getPredicate

public Predicate getPredicate()

Gets the predicate.

Returns:

the predicate

Since:

Commons Collections 3.1