org.apache.commons.collections.functors
Class OrPredicate

java.lang.Object
  |
  +--org.apache.commons.collections.functors.OrPredicate
All Implemented Interfaces:
Predicate, Serializable

public final class OrPredicate
extends Object
implements Predicate, Serializable

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

Since:
Commons Collections 3.0
Version:
$Revision: 1.2 $ $Date: 2004/01/14 21:43:09 $
Author:
Stephen Colebourne
See Also:
Serialized Form

Constructor Summary
OrPredicate(Predicate predicate1, Predicate predicate2)
          Constructor that performs no validation.
 
Method Summary
 boolean evaluate(Object object)
          Return the predicate result.
static Predicate getInstance(Predicate predicate1, Predicate predicate2)
          Factory to create the predicate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrPredicate

public OrPredicate(Predicate predicate1,
                   Predicate 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 Predicate getInstance(Predicate predicate1,
                                    Predicate 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(Object object)
Return the predicate result.
Specified by:
evaluate in interface Predicate
Following copied from interface: org.apache.commons.collections.Predicate
Parameters:
object - the object to evaluate
Returns:
true or false
Throws:
ClassCastException - (runtime) if the input is the wrong class
IllegalArgumentException - (runtime) if the input is invalid
FunctorException - (runtime) if the predicate encounters a problem


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.