org.apache.commons.collections.functors

Class AllPredicate

Implemented Interfaces:
Predicate, PredicateDecorator, Serializable

public final class AllPredicate
extends Object
implements Predicate, PredicateDecorator, Serializable

Predicate implementation that returns true if all the predicates return true. If the array of predicates is empty, then this predicate returns true.

NOTE: In versions prior to 3.2 an array size of zero or one threw an exception.

Version:
$Revision: 406071 $ $Date: 2006-05-13 11:44:37 +0100 (Sat, 13 May 2006) $
Authors:
Stephen Colebourne
Matt Benson
Since:
Commons Collections 3.0

Constructor Summary

AllPredicate(Predicate[] predicates)
Constructor that performs no validation.

Method Summary

boolean
evaluate(Object object)
Evaluates the predicate returning true if all predicates return true.
static Predicate
getInstance(Collection predicates)
Factory to create the predicate.
static Predicate
getInstance(Predicate[] predicates)
Factory to create the predicate.
Predicate[]
getPredicates()
Gets the predicates, do not modify the array.

Constructor Details

AllPredicate

public AllPredicate(Predicate[] predicates)
Constructor that performs no validation. Use getInstance if you want that.
Parameters:
predicates - the predicates to check, not cloned, not null

Method Details

evaluate

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

getInstance

public static Predicate getInstance(Collection predicates)
Factory to create the predicate.

If the collection is size zero, the predicate always returns true. If the collection is size one, then that predicate is returned.

Parameters:
predicates - the predicates to check, cloned, not null
Returns:
the all predicate

getInstance

public static Predicate getInstance(Predicate[] predicates)
Factory to create the predicate.

If the array is size zero, the predicate always returns true. If the array is size one, then that predicate is returned.

Parameters:
predicates - the predicates to check, cloned, not null
Returns:
the all predicate

getPredicates

public Predicate[] getPredicates()
Gets the predicates, do not modify the array.
Specified by:
getPredicates in interface PredicateDecorator
Returns:
the predicates
Since:
Commons Collections 3.1

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