BoundProcedure (Commons Functor 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.functor.adapter.BoundProcedure

All Implemented Interfaces:

Serializable, Runnable, Functor, NullaryFunctor, Procedure
```
public final class BoundProcedure
extends Object
implements Procedure, Serializable
```
Adapts a UnaryProcedure to the Procedure interface using a constant unary argument.
Note that although this class implements Serializable, a given instance will only be truly Serializable if the underlying objects are. Attempts to serialize an instance whose delegates are 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

BoundProcedure(UnaryProcedure<? super A> procedure, A arg)
Create a new BoundProcedure instance.

Constructors
Constructor and Description
`BoundProcedure(UnaryProcedure<? super A> procedure, A arg)` Create a new BoundProcedure instance.

Method Summary

Methods
Modifier and Type	Method and Description
`static <A> BoundProcedure`	`bind(UnaryProcedure<? super A> procedure, A arg)` Adapt the given, possibly-`null`, `UnaryProcedure` to the `Procedure` interface by binding the specified `Object` as a constant argument.
`boolean`	`equals(BoundProcedure that)` Learn whether a given BoundProcedure is equal to this.
`boolean`	`equals(Object that)`
`int`	`hashCode()`
`void`	`run()` Execute this procedure.
`String`	`toString()`

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

- Constructor Detail
  - BoundProcedure
```
public BoundProcedure(UnaryProcedure<? super A> procedure,
              A arg)
```
    Create a new BoundProcedure instance.
    
    Type Parameters:
    A - arg type
    Parameters:
    procedure - the procedure to adapt
    arg - the constant argument to use
- Method Detail
  - run
```
public void run()
```
    Execute this procedure.
    
    Specified by:
    
    run in interface Runnable
    
    Specified by:
    
    run in interface Procedure
  - equals
```
public boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(BoundProcedure that)
```
    Learn whether a given BoundProcedure is equal to this.
    
    Parameters:
    that - the BoundProcedure to test
    
    Returns:
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - bind
```
public static <A> BoundProcedure bind(UnaryProcedure<? super A> procedure,
                      A arg)
```
    Adapt the given, possibly-null, UnaryProcedure to the Procedure interface by binding the specified Object as a constant argument. When the given UnaryProcedure is null, returns null.
    
    Type Parameters:
    A - arg type
    Parameters:
    procedure - the possibly-null UnaryProcedure to adapt
    arg - the object to bind as a constant argument
    
    Returns:
    a BoundProcedure wrapping the given UnaryProcedure, or null if the given UnaryProcedure is null

Class BoundProcedure

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoundProcedure

Method Detail

run

equals

equals

hashCode

toString

bind