BinaryPredicateBinaryFunction (Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.adapter.BinaryPredicateBinaryFunction<L,R>

Type Parameters:
L - the left argument type.
R - the right argument type.

All Implemented Interfaces:

Serializable, BinaryFunction<L,R,Boolean>, BinaryFunctor<L,R>, Functor
```
public final class BinaryPredicateBinaryFunction<L,R>
extends Object
implements BinaryFunction<L,R,Boolean>, Serializable
```
Adapts a BinaryPredicate to the BinaryFunction 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

BinaryPredicateBinaryFunction(BinaryPredicate<? super L,? super R> predicate)
Create a new BinaryPredicateBinaryFunction.

Constructors
Constructor and Description
`BinaryPredicateBinaryFunction(BinaryPredicate<? super L,? super R> predicate)` Create a new BinaryPredicateBinaryFunction.

Method Summary

Methods
Modifier and Type	Method and Description
`static <L,R> BinaryPredicateBinaryFunction<L,R>`	`adapt(BinaryPredicate<? super L,? super R> predicate)` Adapt the given, possibly-`null`, `BinaryPredicate` to the `BinaryFunction` interface.
`boolean`	`equals(BinaryPredicateBinaryFunction<?,?> that)` Learn whether another BinaryPredicateBinaryFunction is equal to this.
`boolean`	`equals(Object that)`
`Boolean`	`evaluate(L left, R right)` Evaluate this function.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - BinaryPredicateBinaryFunction
```
public BinaryPredicateBinaryFunction(BinaryPredicate<? super L,? super R> predicate)
```
    Create a new BinaryPredicateBinaryFunction.
    
    Parameters:
    predicate - to adapt
- Method Detail
  - evaluate
```
public Boolean evaluate(L left,
               R right)
```
    Evaluate this function. Returns Boolean.TRUE (Boolean.FALSE) when the test method of my underlying predicate returns true (false).
    
    Specified by:
    
    evaluate in interface BinaryFunction<L,R,Boolean>
    
    Parameters:
    left - the L element of the ordered pair of arguments
    right - the R element of the ordered pair of arguments
    
    Returns:
    a non-null Boolean instance
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(BinaryPredicateBinaryFunction<?,?> that)
```
    Learn whether another BinaryPredicateBinaryFunction is equal to this.
    
    Parameters:
    that - BinaryPredicateBinaryFunction 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 <L,R> BinaryPredicateBinaryFunction<L,R> adapt(BinaryPredicate<? super L,? super R> predicate)
```
    Adapt the given, possibly-null, BinaryPredicate to the BinaryFunction interface. When the given BinaryPredicate is null, returns null.
    
    Type Parameters:
    L - left type
    R - right type
    Parameters:
    predicate - the possibly-null BinaryPredicate to adapt
    
    Returns:
    a BinaryPredicateBinaryFunction wrapping the given BinaryPredicate, or null if the given BinaryPredicate is null

Class BinaryPredicateBinaryFunction<L,R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryPredicateBinaryFunction

Method Detail

evaluate

equals

equals

hashCode

toString

adapt