BinaryFunctionBinaryProcedure (Commons Functor 1.0-SNAPSHOT API)

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

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

All Implemented Interfaces:

Serializable, BinaryFunctor<L,R>, BinaryProcedure<L,R>, Functor
```
public final class BinaryFunctionBinaryProcedure<L,R>
extends Object
implements BinaryProcedure<L,R>, Serializable
```
Adapts a BinaryFunction to the BinaryProcedure interface by ignoring the value returned by the function.
Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying function 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

BinaryFunctionBinaryProcedure(BinaryFunction<? super L,? super R,?> function)
Create an BinaryProcedure wrapping the given BinaryFunction.

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

Method Summary

Methods
Modifier and Type	Method and Description
`static <L,R> BinaryFunctionBinaryProcedure<L,R>`	`adapt(BinaryFunction<? super L,? super R,?> function)` Adapt the given, possibly-`null`, `BinaryFunction` to the `BinaryProcedure` interface.
`boolean`	`equals(BinaryFunctionBinaryProcedure<?,?> that)` Learn whether a given BinaryFunctionBinaryPredicate is equal to this.
`boolean`	`equals(Object that)`
`int`	`hashCode()`
`void`	`run(L left, R right)` `Evaluate` my function, but ignore its returned value.
`String`	`toString()`

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

- Constructor Detail
  - BinaryFunctionBinaryProcedure
```
public BinaryFunctionBinaryProcedure(BinaryFunction<? super L,? super R,?> function)
```
    Create an BinaryProcedure wrapping the given BinaryFunction.
    
    Parameters:
    function - the BinaryFunction to wrap
- Method Detail
  - run
```
public void run(L left,
       R right)
```
    Evaluate my function, but ignore its returned value. Execute this procedure.
    
    Specified by:
    
    run in interface BinaryProcedure<L,R>
    
    Parameters:
    left - the L element of the ordered pair of arguments
    right - the R element of the ordered pair of arguments
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(BinaryFunctionBinaryProcedure<?,?> that)
```
    Learn whether a given BinaryFunctionBinaryPredicate is equal to this.
    
    Parameters:
    that - BinaryFunctionBinaryPredicate to compare
    
    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> BinaryFunctionBinaryProcedure<L,R> adapt(BinaryFunction<? super L,? super R,?> function)
```
    Adapt the given, possibly-null, BinaryFunction to the BinaryProcedure interface. When the given BinaryFunction is null, returns null.
    
    Type Parameters:
    L - left type
    R - right type
    Parameters:
    function - the possibly-null BinaryFunction to adapt
    
    Returns:
    a BinaryFunctionBinaryProcedure wrapping the given BinaryFunction, or null if the given BinaryFunction is null

Class BinaryFunctionBinaryProcedure<L,R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryFunctionBinaryProcedure

Method Detail

run

equals

equals

hashCode

toString

adapt