org.apache.commons.collections.functors

Class OrPredicate

Implemented Interfaces:
Predicate, PredicateDecorator, Serializable

public final class OrPredicate
extends java.lang.Object
implements Predicate, PredicateDecorator, Serializable

Predicate implementation that returns true if either of the predicates return true.
Version:
$Revision: 1.6 $ $Date: 2004/05/31 16:43:17 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Constructor Summary

OrPredicate(Predicate predicate1, Predicate predicate2)
Constructor that performs no validation.

Method Summary

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

Constructor Details

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 Details

evaluate

public boolean evaluate(Object object)
Evaluates the predicate returning true if either predicate returns true.
Specified by:
evaluate in interface Predicate
Parameters:
object - the input object
Returns:
true if either decorated predicate returns true

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

getPredicates

public Predicate[] getPredicates()
Gets the two predicates being decorated as an array.
Specified by:
getPredicates in interface PredicateDecorator
Returns:
the predicates
Since:
Commons Collections 3.1

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