|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.PredicateUtils
public class PredicateUtils
PredicateUtils provides reference implementations and utilities
for the Predicate functor interface. The supplied predicates are:
| Constructor Summary | |
|---|---|
PredicateUtils()
This class is not normally instantiated. |
|
| Method Summary | |
|---|---|
static Predicate |
allPredicate(java.util.Collection predicates)
Create a new Predicate that returns true only if all of the specified predicates are true. |
static Predicate |
allPredicate(Predicate[] 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(java.util.Collection predicates)
Create a new Predicate that returns true if any 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 |
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(java.lang.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(java.lang.Object value)
Creates a Predicate that checks if the input object is equal to the specified object by identity. |
static Predicate |
instanceofPredicate(java.lang.Class type)
Creates a Predicate that checks if the object passed in is of a particular type, using instanceof. |
static Predicate |
invokerPredicate(java.lang.String methodName)
Creates a Predicate that invokes a method on the input object. |
static Predicate |
invokerPredicate(java.lang.String methodName,
java.lang.Class[] paramTypes,
java.lang.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(java.util.Collection predicates)
Create a new Predicate that returns true if none 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 |
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(java.util.Collection predicates)
Create a new Predicate that returns true if only one of the specified predicates are true. |
static Predicate |
onePredicate(Predicate[] 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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PredicateUtils()
| Method Detail |
|---|
public static Predicate exceptionPredicate()
ExceptionPredicatepublic static Predicate truePredicate()
TruePredicatepublic static Predicate falsePredicate()
FalsePredicatepublic static Predicate nullPredicate()
NullPredicatepublic static Predicate notNullPredicate()
NotNullPredicatepublic static Predicate equalPredicate(java.lang.Object value)
value - the value to compare against
EqualPredicatepublic static Predicate identityPredicate(java.lang.Object value)
value - the value to compare against
IdentityPredicatepublic static Predicate instanceofPredicate(java.lang.Class type)
null input
object will return false.
type - the type to check for, may not be null
java.lang.IllegalArgumentException - if the class is nullInstanceofPredicatepublic static Predicate uniquePredicate()
null input object
is accepted and will return true the first time, and false subsequently
as well.
UniquePredicatepublic static Predicate invokerPredicate(java.lang.String methodName)
For example, PredicateUtils.invokerPredicate("isEmpty");
will call the isEmpty method on the input object to
determine the predicate result.
methodName - the method name to call on the input object, may not be null
java.lang.IllegalArgumentException - if the methodName is null.InvokerTransformer,
TransformerPredicate
public static Predicate invokerPredicate(java.lang.String methodName,
java.lang.Class[] paramTypes,
java.lang.Object[] args)
For example, PredicateUtils.invokerPredicate("isEmpty");
will call the isEmpty method on the input object to
determine the predicate result.
methodName - the method name to call on the input object, may not be nullparamTypes - the parameter typesargs - the arguments
java.lang.IllegalArgumentException - if the method name is null
java.lang.IllegalArgumentException - if the paramTypes and args don't matchInvokerTransformer,
TransformerPredicate
public static Predicate andPredicate(Predicate predicate1,
Predicate predicate2)
predicate1 - the first predicate, may not be nullpredicate2 - the second predicate, may not be null
and predicate
java.lang.IllegalArgumentException - if either predicate is nullAndPredicatepublic static Predicate allPredicate(Predicate[] predicates)
predicates - an array of predicates to check, may not be null
all predicate
java.lang.IllegalArgumentException - if the predicates array is null
java.lang.IllegalArgumentException - if any predicate in the array is nullAllPredicatepublic static Predicate allPredicate(java.util.Collection predicates)
predicates - a collection of predicates to check, may not be null
all predicate
java.lang.IllegalArgumentException - if the predicates collection is null
java.lang.IllegalArgumentException - if any predicate in the collection is nullAllPredicate
public static Predicate orPredicate(Predicate predicate1,
Predicate predicate2)
predicate1 - the first predicate, may not be nullpredicate2 - the second predicate, may not be null
or predicate
java.lang.IllegalArgumentException - if either predicate is nullOrPredicatepublic static Predicate anyPredicate(Predicate[] predicates)
predicates - an array of predicates to check, may not be null
any predicate
java.lang.IllegalArgumentException - if the predicates array is null
java.lang.IllegalArgumentException - if any predicate in the array is nullAnyPredicatepublic static Predicate anyPredicate(java.util.Collection predicates)
predicates - a collection of predicates to check, may not be null
any predicate
java.lang.IllegalArgumentException - if the predicates collection is null
java.lang.IllegalArgumentException - if any predicate in the collection is nullAnyPredicate
public static Predicate eitherPredicate(Predicate predicate1,
Predicate predicate2)
predicate1 - the first predicate, may not be nullpredicate2 - the second predicate, may not be null
either predicate
java.lang.IllegalArgumentException - if either predicate is nullOnePredicatepublic static Predicate onePredicate(Predicate[] predicates)
predicates - an array of predicates to check, may not be null
one predicate
java.lang.IllegalArgumentException - if the predicates array is null
java.lang.IllegalArgumentException - if any predicate in the array is nullOnePredicatepublic static Predicate onePredicate(java.util.Collection predicates)
predicates - a collection of predicates to check, may not be null
one predicate
java.lang.IllegalArgumentException - if the predicates collection is null
java.lang.IllegalArgumentException - if any predicate in the collection is nullOnePredicate
public static Predicate neitherPredicate(Predicate predicate1,
Predicate predicate2)
predicate1 - the first predicate, may not be nullpredicate2 - the second predicate, may not be null
neither predicate
java.lang.IllegalArgumentException - if either predicate is nullNonePredicatepublic static Predicate nonePredicate(Predicate[] predicates)
predicates - an array of predicates to check, may not be null
none predicate
java.lang.IllegalArgumentException - if the predicates array is null
java.lang.IllegalArgumentException - if any predicate in the array is nullNonePredicatepublic static Predicate nonePredicate(java.util.Collection predicates)
predicates - a collection of predicates to check, may not be null
none predicate
java.lang.IllegalArgumentException - if the predicates collection is null
java.lang.IllegalArgumentException - if any predicate in the collection is nullNonePredicatepublic static Predicate notPredicate(Predicate predicate)
predicate - the predicate to not
not predicate
java.lang.IllegalArgumentException - if the predicate is nullNotPredicatepublic static Predicate asPredicate(Transformer transformer)
transformer - the transformer to wrap, may not be null
java.lang.IllegalArgumentException - if the transformer is nullTransformerPredicatepublic static Predicate nullIsExceptionPredicate(Predicate predicate)
predicate - the predicate to wrap, may not be null
java.lang.IllegalArgumentException - if the predicate is null.NullIsExceptionPredicatepublic static Predicate nullIsFalsePredicate(Predicate predicate)
predicate - the predicate to wrap, may not be null
java.lang.IllegalArgumentException - if the predicate is null.NullIsFalsePredicatepublic static Predicate nullIsTruePredicate(Predicate predicate)
predicate - the predicate to wrap, may not be null
java.lang.IllegalArgumentException - if the predicate is null.NullIsTruePredicate
public static Predicate transformedPredicate(Transformer transformer,
Predicate predicate)
transformer - the transformer to call firstpredicate - the predicate to call with the result of the transform
java.lang.IllegalArgumentException - if the transformer or the predicate is nullTransformedPredicate
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||