org.apache.commons.collections.functors
Class OrPredicate<T>

java.lang.Object
  org.apache.commons.collections.functors.OrPredicate<T>

All Implemented Interfaces:

Serializable, PredicateDecorator<T>, Predicate<T>

public final class OrPredicate<T>
extends Object
implements Predicate<T>, PredicateDecorator<T>, Serializable

Predicate implementation that returns true if either of the predicates return true.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:34:33 $

Author:

Matt Hall, John Watkinson, Stephen Colebourne

See Also:

Serialized Form

Constructor Summary

OrPredicate(Predicate<? super T> predicate1, Predicate<? super T> predicate2)
Constructor that performs no validation.

Method Summary

boolean	evaluate(T object) Evaluates the predicate returning true if either predicate returns true.
static <T> Predicate<T>	getInstance(Predicate<? super T> predicate1, Predicate<? super T> predicate2) Factory to create the predicate.
Predicate<? super T>[]	getPredicates() Gets the two predicates being decorated as an array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrPredicate

public OrPredicate(Predicate<? super T> predicate1,
                   Predicate<? super T> predicate2)

Constructor that performs no validation. Use getInstance if you want that.

Parameters:

predicate1 - the first predicate to check, not null

predicate2 - the second predicate to check, not null

Method Detail

getInstance

public static <T> Predicate<T> getInstance(Predicate<? super T> predicate1,
                                           Predicate<? super T> predicate2)

Factory to create the predicate.

Parameters:

predicate1 - the first predicate to check, not null

predicate2 - the second predicate to check, not null

Returns:

the and predicate

Throws:

IllegalArgumentException - if either predicate is null

evaluate

public boolean evaluate(T object)

Evaluates the predicate returning true if either predicate returns true.

Specified by:

evaluate in interface Predicate<T>

Parameters:

object - the input object

Returns:

true if either decorated predicate returns true

getPredicates

public Predicate<? super T>[] getPredicates()

Gets the two predicates being decorated as an array.

Specified by:

getPredicates in interface PredicateDecorator<T>

Returns:

the predicates

Since:

Commons Collections 3.1