PredicateFunction (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

All Implemented Interfaces:

Serializable, Function<Boolean>, Functor, NullaryFunctor
```
public final class PredicateFunction
extends Object
implements Function<Boolean>, Serializable
```
Adapts a Predicate to the Function interface.
Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying predicate is. Attempts to serialize an instance whose delegate is not Serializable will result in an exception.

Version:

$Revision: 1365377 $ $Date: 2012-07-24 20:59:23 -0400 (Tue, 24 Jul 2012) $

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

PredicateFunction(Predicate predicate)
Create a new PredicateFunction.

Method Summary

Methods
Modifier and Type	Method and Description
`static PredicateFunction`	`adapt(Predicate predicate)` Adapt a Predicate to the Function interface.
`boolean`	`equals(Object that)`
`boolean`	`equals(PredicateFunction that)` Learn whether another PredicateFunction is equal to this.
`Boolean`	`evaluate()` 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 predicate)
```
    Create a new PredicateFunction.
    
    Parameters:
    predicate - to adapt
- Method Detail
  - evaluate
```
public Boolean evaluate()
```
    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<Boolean>
    
    Returns:
    a non-null Boolean instance
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(PredicateFunction that)
```
    Learn whether another PredicateFunction is equal to this.
    
    Parameters:
    that - PredicateFunction to test
    
    Returns:
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - adapt
```
public static PredicateFunction adapt(Predicate predicate)
```
    Adapt a Predicate to the Function interface.
    
    Parameters:
    predicate - to adapt
    
    Returns:
    PredicateFunction

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.