PredicateTransformer (Commons Collections 3.2.2 API)

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: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PredicateTransformer(Predicate predicate)
Constructor that performs no validation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.

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)
```
    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