org.apache.commons.collections.functors

Class PredicateTransformer

Implemented Interfaces:
Serializable, Transformer

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

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

Version:
$Revision: 1.5 $ $Date: 2004/05/16 11:36:31 $

Author:
Stephen Colebourne

Since:
Commons Collections 3.0

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.
Object
transform(Object input)
Transforms the input to result by calling a predicate.

Constructor Details

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 Details

getInstance

public static Transformer getInstance(Predicate predicate)
Factory method that performs validation.

Parameters:
predicate - the predicate to call, not null

Returns:
the predicate transformer


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.
Specified by:
transform in interface Transformer

Parameters:
input - the input object to transform

Returns:
the transformed result


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