org.apache.commons.functor.adapter
Class BoundPredicate

java.lang.Object
  org.apache.commons.functor.adapter.BoundPredicate

All Implemented Interfaces:

Serializable, Functor, NullaryFunctor, Predicate

public final class BoundPredicate
extends Object
implements Predicate, Serializable

Adapts a UnaryPredicate to the Predicate interface using a constant unary 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: 1156320 $ $Date: 2011-08-10 21:14:50 +0200 (Wed, 10 Aug 2011) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Constructor Summary

BoundPredicate(UnaryPredicate<? super A> predicate, A arg)
Create a new BoundPredicate instance.

Method Summary

static <A> BoundPredicate	bind(UnaryPredicate<? super A> predicate, A arg) Adapt the given, possibly-null, UnaryPredicate to the Predicate interface by binding the specified Object as a constant argument.
boolean	equals(BoundPredicate that) Learn whether another BoundPredicate 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() 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

BoundPredicate

public BoundPredicate(UnaryPredicate<? super A> predicate,
                      A arg)

Create a new BoundPredicate instance.

Type Parameters:

A - input type

Parameters:

predicate - the predicate to adapt

arg - the constant argument to use

Method Detail

test

public boolean test()

Evaluate this predicate.

Specified by:

test in interface Predicate

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(BoundPredicate that)

Learn whether another BoundPredicate is equal to this.

Parameters:

that - BoundPredicate 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 <A> BoundPredicate bind(UnaryPredicate<? super A> predicate,
                                      A arg)

Adapt the given, possibly-null, UnaryPredicate to the Predicate interface by binding the specified Object as a constant argument. When the given UnaryPredicate is null, returns null.

Type Parameters:

A - input type

Parameters:

predicate - the possibly-null UnaryPredicate to adapt

arg - the object to bind as a constant argument

Returns:

a BoundPredicate wrapping the given UnaryPredicate, or null if the given UnaryPredicate is null