org.apache.commons.functor.core.composite
Class TransformedBinaryProcedure<L,R>

java.lang.Object
  org.apache.commons.functor.core.composite.TransformedBinaryProcedure<L,R>

All Implemented Interfaces:

Serializable, BinaryFunctor<L,R>, BinaryProcedure<L,R>, Functor

public class TransformedBinaryProcedure<L,R>
extends Object
implements BinaryProcedure<L,R>, Serializable

A BinaryProcedure composed of a BinaryFunction whose result is then run through a UnaryProcedure.

Version:

$Revision: 1171154 $ $Date: 2011-09-15 17:58:38 +0200 (Thu, 15 Sep 2011) $

Author:

Matt Benson

See Also:

Serialized Form

Constructor Summary

TransformedBinaryProcedure(BinaryFunction<? super L,? super R,? extends X> function, UnaryProcedure<? super X> procedure)
Create a new TransformedBinaryProcedure.

Method Summary

boolean	equals(Object obj) Indicates whether some other object is "equal to" this functor.
boolean	equals(TransformedBinaryProcedure<?,?> that) Learn whether another TransformedBinaryProcedure is equal to this.
int	hashCode() Returns a hash code for this functor adhering to the general Object.hashCode contract.
void	run(L left, R right) Execute this procedure.
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

Constructor Detail

TransformedBinaryProcedure

public TransformedBinaryProcedure(BinaryFunction<? super L,? super R,? extends X> function,
                                  UnaryProcedure<? super X> procedure)

Create a new TransformedBinaryProcedure.

Type Parameters:

X -

Parameters:

function - BinaryFunction

procedure - UnaryProcedure

Method Detail

run

public final void run(L left,
                      R right)

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 final boolean equals(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 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(TransformedBinaryProcedure<?,?> that)

Learn whether another TransformedBinaryProcedure 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 Object

Returns:

a hash code for this functor

See Also:

Functor.equals(java.lang.Object)

toString

public 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 Object

Returns:

a human readable description of this functor