org.apache.commons.functor.adapter
Class BinaryFunctionBinaryPredicate<L,R>

java.lang.Object
  org.apache.commons.functor.adapter.BinaryFunctionBinaryPredicate<L,R>

All Implemented Interfaces:

java.io.Serializable, BinaryFunctor<L,R>, BinaryPredicate<L,R>, Functor

public final class BinaryFunctionBinaryPredicate<L,R>
extends java.lang.Object
implements BinaryPredicate<L,R>, java.io.Serializable

Adapts a Boolean-valued BinaryFunction to the BinaryPredicate interface.

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

Version:

$Revision: 666155 $ $Date: 2008-06-10 10:31:53 -0500 (Tue, 10 Jun 2008) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Constructor Summary

BinaryFunctionBinaryPredicate(BinaryFunction<? super L,? super R,java.lang.Boolean> function)
Create an BinaryPredicate wrapping the given BinaryFunction.

Method Summary

static <L,R,T> BinaryFunctionBinaryPredicate<L,R>	adapt(BinaryFunction<? super L,? super R,java.lang.Boolean> function) Adapt the given, possibly-null, BinaryFunction to the BinaryPredicate interface.
boolean	equals(BinaryFunctionBinaryPredicate<?,?> that) Learn whether another BinaryFunctionBinaryPredicate is equal to this.
boolean	equals(java.lang.Object that) Indicates whether some other object is "equal to" this functor.
int	hashCode() Returns a hash code for this functor adhering to the general Object.hashCode contract.
boolean	test(L left, R right) Evaluate this predicate. Returns the boolean value of the non-null Boolean returned by the evaluate method of my underlying function.
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

Constructor Detail

BinaryFunctionBinaryPredicate

public BinaryFunctionBinaryPredicate(BinaryFunction<? super L,? super R,java.lang.Boolean> function)

Create an BinaryPredicate wrapping the given BinaryFunction.

Parameters:

function - the BinaryFunction to wrap

Method Detail

test

public boolean test(L left,
                    R right)

Evaluate this predicate. Returns the boolean value of the non-null Boolean returned by the evaluate method of my underlying function.

Specified by:

test in interface BinaryPredicate<L,R>

Parameters:

left - the L element of the ordered pair of arguments

right - the R element of the ordered pair of arguments

Returns:

the result of this test for the given arguments

Throws:

java.lang.NullPointerException - if my underlying function returns null

java.lang.ClassCastException - if my underlying function returns a non-Boolean

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(BinaryFunctionBinaryPredicate<?,?> that)

Learn whether another BinaryFunctionBinaryPredicate is equal to this.

Parameters:

that - BinaryFunctionBinaryPredicate 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 <L,R,T> BinaryFunctionBinaryPredicate<L,R> adapt(BinaryFunction<? super L,? super R,java.lang.Boolean> function)

Adapt the given, possibly-null, BinaryFunction to the BinaryPredicate interface. When the given BinaryFunction is null, returns null.

Parameters:

function - the possibly-null BinaryFunction to adapt

Returns:

a BinaryFunctionBinaryPredicate wrapping the given BinaryFunction, or null if the given BinaryFunction is null