FunctionProcedure (Commons Functor 1.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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

All Implemented Interfaces:

Serializable, Runnable, Functor, NullaryFunctor, Procedure
```
public final class FunctionProcedure
extends Object
implements Procedure, Serializable
```
Adapts a Function to the Procedure 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

FunctionProcedure(Function<?> function)
Create an Procedure wrapping the given Function.

Method Summary

Methods
Modifier and Type	Method and Description
`static FunctionProcedure`	`adapt(Function<?> function)` Adapt the given, possibly-`null`, `Function` to the `Procedure` interface.
`boolean`	`equals(FunctionProcedure that)` Learn whether another FunctionProcedure 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
  - FunctionProcedure
```
public FunctionProcedure(Function<?> function)
```
    Create an Procedure wrapping the given Function.
    
    Parameters:
    function - the Function to wrap
- Method Detail
  - run
```
public void run()
```
    Execute this procedure. Evaluate my function, but ignore its returned value.
    
    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(FunctionProcedure that)
```
    Learn whether another FunctionProcedure is equal to this.
    
    Parameters:
    that - FunctionProcedure 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 FunctionProcedure adapt(Function<?> function)
```
    Adapt the given, possibly-null, Function to the Procedure interface. When the given Function is null, returns null.
    
    Parameters:
    function - the possibly-null Function to adapt
    
    Returns:
    a Procedure wrapping the given Function, or null if the given Function is null

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.