Package org.apache.commons.functor.core.composite

Class TransformedProcedure

java.lang.Object

org.apache.commons.functor.core.composite.TransformedProcedure

All Implemented Interfaces:

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

public class TransformedProcedure
extends java.lang.Object
implements Procedure, java.io.Serializable

A Procedure composed of a Function whose result is then run through a UnaryProcedure.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TransformedProcedure.Helper<X>	Type-remembering helper.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	HASH_SHIFT	Base hash integer used to shift hash.
private TransformedProcedure.Helper<?>	helper	The adapted helper.
private static long	serialVersionUID	serialVersionUID declaration.

Constructor Summary

Constructors

Constructor	Description
TransformedProcedure(Function<? extends X> function, UnaryProcedure<? super X> procedure)	Create a new TransformedProcedure.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)	Indicates whether some other object is "equal to" this functor.
boolean	equals(TransformedProcedure that)	Learn whether another TransformedProcedure 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

HASH_SHIFT

private static final int HASH_SHIFT

Base hash integer used to shift hash.

See Also:

Constant Field Values

helper

private final TransformedProcedure.Helper<?> helper

The adapted helper.

Constructor Detail

TransformedProcedure

public TransformedProcedure(Function<? extends X> function,
                            UnaryProcedure<? super X> procedure)

Create a new TransformedProcedure.

Type Parameters:

X - the adapted function argument type.

Parameters:

function - Function

procedure - UnaryProcedure

Method Detail

run

public final void run()

Execute this procedure.

Specified by:

run in interface Procedure

Specified by:

run in interface java.lang.Runnable

equals

public final boolean equals(java.lang.Object obj)

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:

obj - 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 final boolean equals(TransformedProcedure that)

Learn whether another TransformedProcedure is equal to this.

Parameters:

that - instance to test

Returns:

whether equal

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