BinaryProcedureBinaryFunction (Commons Functor 1.0-SNAPSHOT API)

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

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

All Implemented Interfaces:

Serializable, BinaryFunction<L,R,T>, BinaryFunctor<L,R>, Functor
```
public final class BinaryProcedureBinaryFunction<L,R,T>
extends Object
implements BinaryFunction<L,R,T>, Serializable
```
Adapts a BinaryProcedure to the BinaryFunction interface by always returning null.
Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying procedure 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

BinaryProcedureBinaryFunction(BinaryProcedure<? super L,? super R> procedure)
Create a new BinaryProcedureBinaryFunction.

Constructors
Constructor and Description
`BinaryProcedureBinaryFunction(BinaryProcedure<? super L,? super R> procedure)` Create a new BinaryProcedureBinaryFunction.

Method Summary

Methods
Modifier and Type	Method and Description
`static <L,R,T> BinaryProcedureBinaryFunction<L,R,T>`	`adapt(BinaryProcedure<? super L,? super R> procedure)` Adapt the given, possibly-`null`, `BinaryProcedure` to the `BinaryFunction` interface.
`boolean`	`equals(BinaryProcedureBinaryFunction<?,?,?> that)` Learn whether another BinaryProcedureBinaryFunction is equal to this.
`boolean`	`equals(Object that)`
`T`	`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
  - BinaryProcedureBinaryFunction
```
public BinaryProcedureBinaryFunction(BinaryProcedure<? super L,? super R> procedure)
```
    Create a new BinaryProcedureBinaryFunction.
    
    Parameters:
    procedure - to adapt as a BinaryFunction
- Method Detail
  - evaluate
```
public T evaluate(L left,
         R right)
```
    Evaluate this function.
    
    Specified by:
    
    evaluate in interface BinaryFunction<L,R,T>
    
    Parameters:
    left - the L element of the ordered pair of arguments
    right - the R element of the ordered pair of arguments
    
    Returns:
    the T result of this function for the given arguments
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(BinaryProcedureBinaryFunction<?,?,?> that)
```
    Learn whether another BinaryProcedureBinaryFunction is equal to this.
    
    Parameters:
    that - the BinaryProcedureBinaryFunction 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,T> BinaryProcedureBinaryFunction<L,R,T> adapt(BinaryProcedure<? super L,? super R> procedure)
```
    Adapt the given, possibly-null, BinaryProcedure to the BinaryFunction interface. When the given BinaryProcedure is null, returns null.
    
    Type Parameters:
    L - the left argument type.
    R - the right argument type.
    T - the returned value type.
    Parameters:
    procedure - the possibly-null BinaryFunction to adapt
    
    Returns:
    a BinaryProcedureBinaryFunction wrapping the given BinaryFunction, or null if the given BinaryFunction is null

Class BinaryProcedureBinaryFunction<L,R,T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryProcedureBinaryFunction

Method Detail

evaluate

equals

equals

hashCode

toString

adapt