org.apache.commons.functor.core.composite
Class Or

java.lang.Object
  org.apache.commons.functor.core.composite.Or

All Implemented Interfaces:

Serializable, Functor, NullaryFunctor, Predicate

public final class Or
extends Object

Tests true iff at least one of its children test true. Note that by this definition, the "or" of an empty collection of predicates tests false.

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: 1156320 $ $Date: 2011-08-10 21:14:50 +0200 (Wed, 10 Aug 2011) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Constructor Summary

Or()
Create a new Or.

Or(Iterable<Predicate> predicates)
Create a new Or instance.

Or(Predicate... predicates)
Create a new Or instance.

Method Summary

protected void	addPredicate(Predicate p) Add a Predicate to the list.
boolean	equals(Object that) Indicates whether some other object is "equal to" this functor.
boolean	equals(Or that) Learn whether another Or is equal to this.
protected List<Predicate>	getPredicateList() Get the "live" list of Predicates.
protected boolean	getPredicateListEquals(org.apache.commons.functor.core.composite.BasePredicateList that) Learn whether the list of another BasePredicateList is equal to my list.
protected int	getPredicateListHashCode() Get a hashCode for my list.
protected String	getPredicateListToString() Get a toString for my list.
int	hashCode() Returns a hash code for this functor adhering to the general Object.hashCode contract.
Or	or(Predicate p) Fluently add a Predicate.
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

Or

public Or()

Create a new Or.

Or

public Or(Iterable<Predicate> predicates)

Create a new Or instance.

Parameters:

predicates -

Or

public Or(Predicate... predicates)

Create a new Or instance.

Parameters:

predicates -

Method Detail

or

public Or or(Predicate p)

Fluently add a Predicate.

Parameters:

p - Predicate to add

Returns:

this

test

public boolean test()

Evaluate this 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

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

Learn whether another Or is equal to this.

Parameters:

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

addPredicate

protected void addPredicate(Predicate p)

Add a Predicate to the list.

Parameters:

p - Predicate to add

getPredicateList

protected List<Predicate> getPredicateList()

Get the "live" list of Predicates.

Returns:

List

getPredicateListEquals

protected boolean getPredicateListEquals(org.apache.commons.functor.core.composite.BasePredicateList that)

Learn whether the list of another BasePredicateList is equal to my list.

Parameters:

that - BasePredicateList to test

Returns:

boolean

getPredicateListHashCode

protected int getPredicateListHashCode()

Get a hashCode for my list.

Returns:

int

getPredicateListToString

protected String getPredicateListToString()

Get a toString for my list.

Returns:

String