Class ConditionalPredicate

java.lang.Object

org.apache.commons.functor.core.composite.ConditionalPredicate

All Implemented Interfaces:

Serializable, Functor, NullaryFunctor, Predicate

public final class ConditionalPredicate
extends Object
implements Predicate, Serializable

A Predicate similiar to Java's "ternary" or "conditional" operator (? :). Given three predicates p, q, r, tests to p.test() ? q.test() : r.test().

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$ $Date$

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final Predicate	elsePred	the predicate executed if the condition is not satisfied.
private static final int	HASH_SHIFT	Base hash integer used to shift hash.
private final Predicate	ifPred	the condition to be evaluated.
private static final long	serialVersionUID	serialVersionUID declaration.
private final Predicate	thenPred	the predicate executed if the condition is satisfied.

Constructor Summary

Constructors

Constructor	Description
ConditionalPredicate(Predicate ifPred, Predicate thenPred, Predicate elsePred)	Create a new ConditionalPredicate.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object that)	Indicates whether some other object is "equal to" this functor.
boolean	equals(ConditionalPredicate that)	Learn whether another ConditionalPredicate is equal to this.
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 Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

serialVersionUID declaration.

See Also:

• Constant Field Values

HASH_SHIFT

private static final int HASH_SHIFT

Base hash integer used to shift hash.

See Also:

• Constant Field Values

ifPred

private final Predicate ifPred

the condition to be evaluated.

thenPred

private final Predicate thenPred

the predicate executed if the condition is satisfied.

elsePred

private final Predicate elsePred

the predicate executed if the condition is not satisfied.

Constructor Details

ConditionalPredicate

public ConditionalPredicate(Predicate ifPred,
 Predicate thenPred,
 Predicate elsePred)

Create a new ConditionalPredicate.

Parameters:

ifPred - if

thenPred - then

elsePred - else

Method Details

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

Learn whether another ConditionalPredicate is equal to this.

Parameters:

that - ConditionalPredicate 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(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