Package org.apache.commons.collections4.functors

# Class TransformerPredicate<T>

java.lang.Object
org.apache.commons.collections4.functors.AbstractPredicate<T>
org.apache.commons.collections4.functors.TransformerPredicate<T>

Type Parameters:
  `T` - the type of the input to the predicate.

All Implemented Interfaces:
  `Serializable`, `Predicate<T>`, `Predicate<T>`

public final class TransformerPredicate<T> extends AbstractPredicate<T> implements Serializable
Predicate implementation that returns the result of a transformer.

Since:
  3.0
See Also:
  - Serialized Form

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `TransformerPredicate(Transformer<? super T,Boolean> transformer)`
  Constructor that performs no validation.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Transformer<? super T,Boolean>`
  `getTransformer()`
  Gets the transformer.
  `boolean`
  `test(T object)`
  Evaluates the predicate returning the result of the decorated transformer.
  `static <T> Predicate<T>`
  `transformerPredicate(Transformer<? super T,Boolean> transformer)`
  Creates the predicate.

  ### Methods inherited from class org.apache.commons.collections4.functors.AbstractPredicate

  `evaluate`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface java.util.function.Predicate

  `and, negate, or`

- ## Constructor Details

  - ### TransformerPredicate

    public TransformerPredicate(Transformer<? super T,Boolean> transformer)
    Constructor that performs no validation. Use `transformerPredicate` if you want that.
    Parameters:
      `transformer` - the transformer to decorate

- ## Method Details

  - ### transformerPredicate

    public static <T> Predicate<T> transformerPredicate(Transformer<? super T,Boolean> transformer)
    Creates the predicate.
    Type Parameters:
      `T` - the type that the predicate queries
    Parameters:
      `transformer` - the transformer to decorate
    Returns:
      the predicate
    Throws:
      `NullPointerException` - if the transformer is null

  - ### getTransformer

    public Transformer<? super T,Boolean> getTransformer()
    Gets the transformer.
    Returns:
      the transformer
    Since:
      3.1

  - ### test

    public boolean test(T object)
    Evaluates the predicate returning the result of the decorated transformer.
    Specified by:
      `test` in interface `Predicate<T>`
    Specified by:
      `test` in interface `Predicate<T>`
    Parameters:
      `object` - the input object
    Returns:
      true if decorated transformer returns Boolean.TRUE
    Throws:
      `FunctorException` - if the transformer returns an invalid type