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

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

All Implemented Interfaces:

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

public final class BinaryAnd<L,R>
extends java.lang.Object

Tests true iff none of its children test false. Note that by this definition, the "and" of an empty collection of predicates tests true.

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: 665786 $ $Date: 2008-06-09 12:17:39 -0500 (Mon, 09 Jun 2008) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Constructor Summary

BinaryAnd()
Create a new BinaryAnd.

BinaryAnd(BinaryPredicate<? super L,? super R> p)
Create a new BinaryAnd.

BinaryAnd(BinaryPredicate<? super L,? super R> p, BinaryPredicate<? super L,? super R> q)
Create a new BinaryAnd.

BinaryAnd(BinaryPredicate<? super L,? super R> p, BinaryPredicate<? super L,? super R> q, BinaryPredicate<? super L,? super R> r)
Create a new BinaryAnd.

Method Summary

protected void	addBinaryPredicate(BinaryPredicate<? super L,? super R> p) Add a BinaryPredicate to the list
BinaryAnd<L,R>	and(BinaryPredicate<? super L,? super R> p) And in a BinaryPredicate.
boolean	equals(BinaryAnd<?,?> that) Learn whether another BinaryAnd is equal to this.
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.
protected java.util.Iterator<BinaryPredicate<? super L,? super R>>	getBinaryPredicateIterator() Get an Iterator over the list contents.
protected boolean	getBinaryPredicateListEquals(org.apache.commons.functor.core.composite.BaseBinaryPredicateList<?,?> that) Learn whether another list is equal to this one.
protected int	getBinaryPredicateListHashCode() Get a hashCode for the list.
protected java.lang.String	getBinaryPredicateListToString() Get a toString for the list.
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.
boolean	test(L a, R b) Evaluate this predicate.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryAnd

public BinaryAnd()

Create a new BinaryAnd.

BinaryAnd

public BinaryAnd(BinaryPredicate<? super L,? super R> p)

Create a new BinaryAnd.

Parameters:

p - BinaryPredicate to add

BinaryAnd

public BinaryAnd(BinaryPredicate<? super L,? super R> p,
                 BinaryPredicate<? super L,? super R> q)

Create a new BinaryAnd.

Parameters:

p - BinaryPredicate to add

q - BinaryPredicate to add

BinaryAnd

public BinaryAnd(BinaryPredicate<? super L,? super R> p,
                 BinaryPredicate<? super L,? super R> q,
                 BinaryPredicate<? super L,? super R> r)

Create a new BinaryAnd.

Parameters:

p - BinaryPredicate to add

q - BinaryPredicate to add

r - BinaryPredicate to add

Method Detail

and

public BinaryAnd<L,R> and(BinaryPredicate<? super L,? super R> p)

And in a BinaryPredicate.

Parameters:

p - BinaryPredicate to add

Returns:

this

test

public boolean test(L a,
                    R b)

Evaluate this predicate.

Parameters:

a - the L element of the ordered pair of arguments

b - the R element of the ordered pair of arguments

Returns:

the result of this test for the given arguments

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

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

Learn whether another BinaryAnd is equal to this.

Parameters:

that - the BinaryAnd 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

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

Returns:

a human readable description of this functor

addBinaryPredicate

protected void addBinaryPredicate(BinaryPredicate<? super L,? super R> p)

Add a BinaryPredicate to the list

Parameters:

p - BinaryPredicate to add

getBinaryPredicateIterator

protected java.util.Iterator<BinaryPredicate<? super L,? super R>> getBinaryPredicateIterator()

Get an Iterator over the list contents.

Returns:

Iterator

getBinaryPredicateListEquals

protected boolean getBinaryPredicateListEquals(org.apache.commons.functor.core.composite.BaseBinaryPredicateList<?,?> that)

Learn whether another list is equal to this one.

Parameters:

that - BaseBinaryPredicateList to test

Returns:

boolean

getBinaryPredicateListHashCode

protected int getBinaryPredicateListHashCode()

Get a hashCode for the list.

Returns:

int

getBinaryPredicateListToString

protected java.lang.String getBinaryPredicateListToString()

Get a toString for the list.

Returns:

String