BinaryFunctionBinaryPredicate (Apache Commons Functor 1.0-SNAPSHOT API)

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

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

All Implemented Interfaces:

BinaryFunctor<L,R>, BinaryPredicate<L,R>, Functor
```
public final class BinaryFunctionBinaryPredicate<L,R>
extends Object
implements BinaryPredicate<L,R>
```
Adapts a Boolean-valued BinaryFunction to the BinaryPredicate interface.

Version:

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

Constructor Summary

Constructors
Constructor and Description

BinaryFunctionBinaryPredicate(BinaryFunction<? super L,? super R,Boolean> function)
Create an BinaryPredicate wrapping the given BinaryFunction.

Constructors
Constructor and Description
`BinaryFunctionBinaryPredicate(BinaryFunction<? super L,? super R,Boolean> function)` Create an `BinaryPredicate` wrapping the given `BinaryFunction`.

Method Summary

Methods
Modifier and Type	Method and Description
`static <L,R,T> BinaryFunctionBinaryPredicate<L,R>`	`adapt(BinaryFunction<? super L,? super R,Boolean> function)` Adapt the given, possibly-`null`, `BinaryFunction` to the `BinaryPredicate` interface.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`boolean`	`test(L left, R right)` Evaluate this predicate.
`String`	`toString()`

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

- Constructor Detail
  - BinaryFunctionBinaryPredicate
```
public BinaryFunctionBinaryPredicate(BinaryFunction<? super L,? super R,Boolean> function)
```
    Create an BinaryPredicate wrapping the given BinaryFunction.
    
    Parameters:
    function - the BinaryFunction to wrap
- Method Detail
  - test
```
public boolean test(L left,
           R right)
```
    Evaluate this predicate. Returns the boolean value of the non-null Boolean returned by the evaluate method of my underlying function. The mehod throws NullPointerException if the underlying function returns null, and ClassCastException if the underlying function returns a non-Boolean
    
    Specified by:
    
    test in interface BinaryPredicate<L,R>
    
    Parameters:
    left - the L element of the ordered pair of arguments
    right - the R element of the ordered pair of arguments
    
    Returns:
    the result of this test for the given arguments
  - 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 <L,R,T> BinaryFunctionBinaryPredicate<L,R> adapt(BinaryFunction<? super L,? super R,Boolean> function)
```
    Adapt the given, possibly-null, BinaryFunction to the BinaryPredicate interface. When the given BinaryFunction is null, returns null.
    
    Type Parameters:
    L - left type
    R - right type
    T - result type
    Parameters:
    function - the possibly-null BinaryFunction to adapt
    
    Returns:
    a BinaryFunctionBinaryPredicate wrapping the given BinaryFunction, or null if the given BinaryFunction is null

Class BinaryFunctionBinaryPredicate<L,R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryFunctionBinaryPredicate

Method Detail

test

equals

hashCode

toString

adapt