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

Class BinaryCompositeBinaryFunction<L,R,T>

java.lang.Object

org.apache.commons.functor.core.composite.BinaryCompositeBinaryFunction<L,R,T>

Type Parameters:

L - the function left argument type.

R - the function right argument type.

T - the function returned value type.

All Implemented Interfaces:

java.io.Serializable, BinaryFunction<L,R,T>, BinaryFunctor<L,R>, Functor

public class BinaryCompositeBinaryFunction<L,R,T>
extends java.lang.Object
implements BinaryFunction<L,R,T>, java.io.Serializable

A BinaryFunction composed of three binary functions, f, g and h, evaluating the ordered parameters x, y to f(g(x,y),h(x,y)).

Note that although this class implements Serializable, a given instance will only be truly Serializable if all the underlying functors are. Attempts to serialize an instance whose delegates are not all Serializable will result in an exception.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BinaryCompositeBinaryFunction.Helper<G,H,L,R,T>	Type-remembering Helper.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	HASH_SHIFT	Base hash integer used to shift hash.
private BinaryCompositeBinaryFunction.Helper<?,?,L,R,T>	helper	The helper used for the evaluation.
private static long	serialVersionUID	serialVersionUID declaration.

Constructor Summary

Constructors

Constructor	Description
BinaryCompositeBinaryFunction(BinaryFunction<? super G,? super H,? extends T> f, BinaryFunction<? super L,? super R,? extends G> g, BinaryFunction<? super L,? super R,? extends H> h)	Create a new BinaryCompositeBinaryFunction.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object that)	Indicates whether some other object is "equal to" this functor.
boolean	equals(BinaryCompositeBinaryFunction<?,?,?> that)	Learn whether another BinaryCompositeBinaryFunction is equal to this.
T	evaluate(L left, R right)	Evaluate this function.
int	hashCode()	Returns a hash code for this functor adhering to the general Object.hashCode contract.
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 BinaryCompositeBinaryFunction.Helper<?,?,L,R,T> helper

The helper used for the evaluation.

Constructor Detail

BinaryCompositeBinaryFunction

public BinaryCompositeBinaryFunction(BinaryFunction<? super G,? super H,? extends T> f,
                                     BinaryFunction<? super L,? super R,? extends G> g,
                                     BinaryFunction<? super L,? super R,? extends H> h)

Create a new BinaryCompositeBinaryFunction.

Type Parameters:

G - the main function left argument type.

H - the main function right argument type.

Parameters:

f - final BinaryFunction to evaluate

g - left preceding BinaryFunction

h - right preceding BinaryFunction

Method Detail

evaluate

public final T evaluate(L left,
                        R right)

Evaluate this function.

Specified by:

evaluate in interface BinaryFunction<L,R,T>

Parameters:

left - the L element of the ordered pair of arguments

right - the R element of the ordered pair of arguments

Returns:

the T result of this function for the given arguments

equals

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

Learn whether another BinaryCompositeBinaryFunction is equal to this.

Parameters:

that - BinaryCompositeBinaryFunction 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