Package org.apache.commons.functor.adapter

Class FunctionProcedure

java.lang.Object

org.apache.commons.functor.adapter.FunctionProcedure

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Functor, NullaryFunctor, Procedure

public final class FunctionProcedure
extends java.lang.Object
implements Procedure, java.io.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$ $Date$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Function<?>	function	The Function I'm wrapping.
private static long	serialVersionUID	serialVersionUID declaration.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static FunctionProcedure	adapt(Function<?> function)	Adapt the given, possibly-null, Function to the Procedure interface.
boolean	equals(java.lang.Object that)	Indicates whether some other object is "equal to" this functor.
boolean	equals(FunctionProcedure that)	Learn whether another FunctionProcedure is equal to this.
int	hashCode()	Returns a hash code for this functor adhering to the general Object.hashCode contract.
void	run()	Execute this procedure.
java.lang.String	toString()	Returns a human readable description of this functor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

serialVersionUID declaration.

See Also:

Constant Field Values

function

private final Function<?> function

The Function I'm wrapping.

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 Procedure

Specified by:

run in interface java.lang.Runnable

equals

public boolean equals(java.lang.Object that)

Indicates whether some other object is "equal to" this functor. This method must adhere to general Object.equals contract. Additionally, this method can return true only if the specified Object implements the same functor interface and is known to produce the same results and/or side-effects for the same arguments (if any).

While implementators are strongly encouraged to override the default Object implementation of this method, note that the default Object implementation does in fact adhere to the functor equals contract.

Specified by:

equals in interface Functor

Overrides:

equals in class java.lang.Object

Parameters:

that - the object to compare this functor to

Returns:

true iff the given object implements this functor interface, and is known to produce the same results and/or side-effects for the same arguments (if any).

See Also:

Functor.hashCode()

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()

Returns a hash code for this functor adhering to the general Object.hashCode contract. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Specified by:

hashCode in interface Functor

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this functor

See Also:

Functor.equals(java.lang.Object)

toString

public java.lang.String toString()

Returns a human readable description of this functor. Implementators are strongly encouraged but not strictly required to override the default Object implementation of this method.

Specified by:

toString in interface Functor

Overrides:

toString in class java.lang.Object

Returns:

a human readable description of this functor

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