PredicateFunction (Apache Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.functor.adapter.PredicateFunction<A>

Type Parameters:
A - the argument type.

All Implemented Interfaces:

Function<A,Boolean>, Functor, UnaryFunctor<A>
```
public final class PredicateFunction<A>
extends Object
implements Function<A,Boolean>
```
Adapts a Predicate to the Function interface.

Version:

$Revision: 1537906 $ $Date: 2013-11-01 12:47:33 +0100 (Fr, 01 Nov 2013) $

Constructor Summary

Constructors
Constructor and Description

PredicateFunction(Predicate<? super A> predicate)
Create a new PredicateFunction.

Method Summary

Methods
Modifier and Type	Method and Description
`static <A> PredicateFunction<A>`	`adapt(Predicate<? super A> predicate)` Adapt a Predicate to the Function interface.
`boolean`	`equals(Object obj)`
`Boolean`	`evaluate(A obj)` Evaluate this function.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PredicateFunction
```
public PredicateFunction(Predicate<? super A> predicate)
```
    Create a new PredicateFunction.
    
    Parameters:
    predicate - to adapt
- Method Detail
  - evaluate
```
public Boolean evaluate(A obj)
```
    Evaluate this function. Returns Boolean.TRUE (Boolean.FALSE) when the test method of my underlying predicate returns true (false).
    
    Specified by:
    
    evaluate in interface Function<A,Boolean>
    
    Parameters:
    obj - the A object to evaluate
    
    Returns:
    a non-null Boolean instance
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - adapt
```
public static <A> PredicateFunction<A> adapt(Predicate<? super A> predicate)
```
    Adapt a Predicate to the Function interface.
    
    Type Parameters:
    A - the argument type.
    Parameters:
    predicate - to adapt
    
    Returns:
    PredicateFunction

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003–2014 The Apache Software Foundation. All rights reserved.