org.apache.commons.collections
public class PredicateUtils extends Object
PredicateUtils
provides reference implementations and utilities
for the Predicate functor interface. The supplied predicates are:
Since: Commons Collections 3.0
Version: $Revision: 377508 $ $Date: 2006-02-13 22:12:33 +0000 (Mon, 13 Feb 2006) $
Constructor Summary | |
---|---|
PredicateUtils()
This class is not normally instantiated. |
Method Summary | |
---|---|
static Predicate | allPredicate(Predicate[] predicates)
Create a new Predicate that returns true only if all of the specified
predicates are true.
|
static Predicate | allPredicate(Collection predicates)
Create a new Predicate that returns true only if all of the specified
predicates are true. |
static Predicate | andPredicate(Predicate predicate1, Predicate predicate2)
Create a new Predicate that returns true only if both of the specified
predicates are true.
|
static Predicate | anyPredicate(Predicate[] predicates)
Create a new Predicate that returns true if any of the specified
predicates are true.
|
static Predicate | anyPredicate(Collection predicates)
Create a new Predicate that returns true if any of the specified
predicates are true. |
static Predicate | asPredicate(Transformer transformer)
Create a new Predicate that wraps a Transformer. |
static Predicate | eitherPredicate(Predicate predicate1, Predicate predicate2)
Create a new Predicate that returns true if one, but not both, of the
specified predicates are true.
|
static Predicate | equalPredicate(Object value)
Creates a Predicate that checks if the input object is equal to the
specified object using equals().
|
static Predicate | exceptionPredicate()
Gets a Predicate that always throws an exception.
|
static Predicate | falsePredicate()
Gets a Predicate that always returns false.
|
static Predicate | identityPredicate(Object value)
Creates a Predicate that checks if the input object is equal to the
specified object by identity.
|
static Predicate | instanceofPredicate(Class type)
Creates a Predicate that checks if the object passed in is of
a particular type, using instanceof. |
static Predicate | invokerPredicate(String methodName)
Creates a Predicate that invokes a method on the input object.
|
static Predicate | invokerPredicate(String methodName, Class[] paramTypes, Object[] args)
Creates a Predicate that invokes a method on the input object.
|
static Predicate | neitherPredicate(Predicate predicate1, Predicate predicate2)
Create a new Predicate that returns true if neither of the specified
predicates are true.
|
static Predicate | nonePredicate(Predicate[] predicates)
Create a new Predicate that returns true if none of the specified
predicates are true.
|
static Predicate | nonePredicate(Collection predicates)
Create a new Predicate that returns true if none of the specified
predicates are true. |
static Predicate | notNullPredicate()
Gets a Predicate that checks if the input object passed in is not null.
|
static Predicate | notPredicate(Predicate predicate)
Create a new Predicate that returns true if the specified predicate
returns false and vice versa.
|
static Predicate | nullIsExceptionPredicate(Predicate predicate)
Gets a Predicate that throws an exception if the input object is null,
otherwise it calls the specified Predicate. |
static Predicate | nullIsFalsePredicate(Predicate predicate)
Gets a Predicate that returns false if the input object is null, otherwise
it calls the specified Predicate. |
static Predicate | nullIsTruePredicate(Predicate predicate)
Gets a Predicate that returns true if the input object is null, otherwise
it calls the specified Predicate. |
static Predicate | nullPredicate()
Gets a Predicate that checks if the input object passed in is null.
|
static Predicate | onePredicate(Predicate[] predicates)
Create a new Predicate that returns true if only one of the specified
predicates are true.
|
static Predicate | onePredicate(Collection predicates)
Create a new Predicate that returns true if only one of the specified
predicates are true. |
static Predicate | orPredicate(Predicate predicate1, Predicate predicate2)
Create a new Predicate that returns true if either of the specified
predicates are true.
|
static Predicate | transformedPredicate(Transformer transformer, Predicate predicate)
Creates a predicate that transforms the input object before passing it
to the predicate.
|
static Predicate | truePredicate()
Gets a Predicate that always returns true.
|
static Predicate | uniquePredicate()
Creates a Predicate that returns true the first time an object is
encountered, and false if the same object is received
again. |
Parameters: predicates an array of predicates to check, may not be null
Returns: the all
predicate
Throws: IllegalArgumentException if the predicates array is null IllegalArgumentException if any predicate in the array is null
Parameters: predicates a collection of predicates to check, may not be null
Returns: the all
predicate
Throws: IllegalArgumentException if the predicates collection is null IllegalArgumentException if any predicate in the collection is null
Parameters: predicate1 the first predicate, may not be null predicate2 the second predicate, may not be null
Returns: the and
predicate
Throws: IllegalArgumentException if either predicate is null
Parameters: predicates an array of predicates to check, may not be null
Returns: the any
predicate
Throws: IllegalArgumentException if the predicates array is null IllegalArgumentException if any predicate in the array is null
Parameters: predicates a collection of predicates to check, may not be null
Returns: the any
predicate
Throws: IllegalArgumentException if the predicates collection is null IllegalArgumentException if any predicate in the collection is null
Parameters: transformer the transformer to wrap, may not be null
Returns: the transformer wrapping predicate
Throws: IllegalArgumentException if the transformer is null
Parameters: predicate1 the first predicate, may not be null predicate2 the second predicate, may not be null
Returns: the either
predicate
Throws: IllegalArgumentException if either predicate is null
Parameters: value the value to compare against
Returns: the predicate
Returns: the predicate
Parameters: value the value to compare against
Returns: the predicate
null
input
object will return false
.
Parameters: type the type to check for, may not be null
Returns: the predicate
Throws: IllegalArgumentException if the class is null
For example, PredicateUtils.invokerPredicate("isEmpty");
will call the isEmpty
method on the input object to
determine the predicate result.
Parameters: methodName the method name to call on the input object, may not be null
Returns: the predicate
Throws: IllegalArgumentException if the methodName is null.
See Also: InvokerTransformer
For example, PredicateUtils.invokerPredicate("isEmpty");
will call the isEmpty
method on the input object to
determine the predicate result.
Parameters: methodName the method name to call on the input object, may not be null paramTypes the parameter types args the arguments
Returns: the predicate
Throws: IllegalArgumentException if the method name is null IllegalArgumentException if the paramTypes and args don't match
See Also: InvokerTransformer
Parameters: predicate1 the first predicate, may not be null predicate2 the second predicate, may not be null
Returns: the neither
predicate
Throws: IllegalArgumentException if either predicate is null
Parameters: predicates an array of predicates to check, may not be null
Returns: the none
predicate
Throws: IllegalArgumentException if the predicates array is null IllegalArgumentException if any predicate in the array is null
Parameters: predicates a collection of predicates to check, may not be null
Returns: the none
predicate
Throws: IllegalArgumentException if the predicates collection is null IllegalArgumentException if any predicate in the collection is null
Returns: the predicate
Parameters: predicate the predicate to not
Returns: the not
predicate
Throws: IllegalArgumentException if the predicate is null
Parameters: predicate the predicate to wrap, may not be null
Returns: the predicate
Throws: IllegalArgumentException if the predicate is null.
Parameters: predicate the predicate to wrap, may not be null
Returns: the predicate
Throws: IllegalArgumentException if the predicate is null.
Parameters: predicate the predicate to wrap, may not be null
Returns: the predicate
Throws: IllegalArgumentException if the predicate is null.
Returns: the predicate
Parameters: predicates an array of predicates to check, may not be null
Returns: the one
predicate
Throws: IllegalArgumentException if the predicates array is null IllegalArgumentException if any predicate in the array is null
Parameters: predicates a collection of predicates to check, may not be null
Returns: the one
predicate
Throws: IllegalArgumentException if the predicates collection is null IllegalArgumentException if any predicate in the collection is null
Parameters: predicate1 the first predicate, may not be null predicate2 the second predicate, may not be null
Returns: the or
predicate
Throws: IllegalArgumentException if either predicate is null
Parameters: transformer the transformer to call first predicate the predicate to call with the result of the transform
Returns: the predicate
Throws: IllegalArgumentException if the transformer or the predicate is null
Since: Commons Collections 3.1
null
input object
is accepted and will return true the first time, and false subsequently
as well.
Returns: the predicate