org.apache.commons.functor.adapter
Class LeftBoundPredicate<A>

java.lang.Object
  org.apache.commons.functor.adapter.LeftBoundPredicate<A>

Type Parameters:

A - the argument type.

All Implemented Interfaces:

Serializable, Functor, UnaryFunctor<A>, UnaryPredicate<A>

public final class LeftBoundPredicate<A>
extends Object
implements UnaryPredicate<A>, Serializable

Adapts a BinaryPredicate to the UnaryPredicate interface using a constant left-side argument.

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

Version:

$Revision: 1157623 $ $Date: 2011-08-14 21:59:51 +0200 (Sun, 14 Aug 2011) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Constructor Summary

LeftBoundPredicate(BinaryPredicate<? super L,? super A> predicate, L arg)
Create a new LeftBoundPredicate.

Method Summary

static <L,R> LeftBoundPredicate<R>	bind(BinaryPredicate<? super L,? super R> predicate, L arg) Adapt a BinaryPredicate to the UnaryPredicate interface.
boolean	equals(LeftBoundPredicate<?> that) Learn whether another LeftBoundPredicate is equal to this.
boolean	equals(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(A obj) Evaluate this predicate.
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

LeftBoundPredicate

public LeftBoundPredicate(BinaryPredicate<? super L,? super A> predicate,
                          L arg)

Create a new LeftBoundPredicate.

Type Parameters:

L - the left argument type.

Parameters:

predicate - the predicate to adapt

arg - the constant argument to use

Method Detail

test

public boolean test(A obj)

Evaluate this predicate.

Specified by:

test in interface UnaryPredicate<A>

Parameters:

obj - the A object to test

Returns:

the result of this test

equals

public boolean equals(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 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(LeftBoundPredicate<?> that)

Learn whether another LeftBoundPredicate is equal to this.

Parameters:

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

bind

public static <L,R> LeftBoundPredicate<R> bind(BinaryPredicate<? super L,? super R> predicate,
                                               L arg)

Adapt a BinaryPredicate to the UnaryPredicate interface.

Type Parameters:

L - the left argument type.

R - the right argument type.

Parameters:

predicate - to adapt

arg - Object argument to always send as the left operand to the wrapped function

Returns:

LeftBoundPredicate