|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.collections.ClosureUtils
ClosureUtils
provides reference implementations and utilities
for the Closure functor interface. The supplied closures are:
Constructor Summary | |
ClosureUtils()
This class is not normally instantiated. |
Method Summary | |
static Closure |
asClosure(Transformer transformer)
Creates a Closure that calls a Transformer each time it is called. |
static Closure |
chainedClosure(Closure[] closures)
Create a new Closure that calls each closure in turn, passing the result into the next closure. |
static Closure |
chainedClosure(Closure closure1,
Closure closure2)
Create a new Closure that calls two Closures, passing the result of the first into the second. |
static Closure |
chainedClosure(Collection closures)
Create a new Closure that calls each closure in turn, passing the result into the next closure. |
static Closure |
doWhileClosure(Closure closure,
Predicate predicate)
Creates a Closure that will call the closure once and then repeatedly until the predicate returns false. |
static Closure |
exceptionClosure()
Gets a Closure that always throws an exception. |
static Closure |
forClosure(int count,
Closure closure)
Creates a Closure that will call the closure count times. |
static Closure |
ifClosure(Predicate predicate,
Closure trueClosure,
Closure falseClosure)
Create a new Closure that calls one of two closures depending on the specified predicate. |
static Closure |
invokerClosure(String methodName)
Creates a Closure that will invoke a specific method on the closure's input object by reflection. |
static Closure |
invokerClosure(String methodName,
Class[] paramTypes,
Object[] args)
Creates a Closure that will invoke a specific method on the closure's input object by reflection. |
static Closure |
nopClosure()
Gets a Closure that will do nothing. |
static Closure |
switchClosure(Map predicatesAndClosures)
Create a new Closure that calls one of the closures depending on the predicates. |
static Closure |
switchClosure(Predicate[] predicates,
Closure[] closures)
Create a new Closure that calls one of the closures depending on the predicates. |
static Closure |
switchClosure(Predicate[] predicates,
Closure[] closures,
Closure defaultClosure)
Create a new Closure that calls one of the closures depending on the predicates. |
static Closure |
switchMapClosure(Map objectsAndClosures)
Create a new Closure that uses the input object as a key to find the closure to call. |
static Closure |
whileClosure(Predicate predicate,
Closure closure)
Creates a Closure that will call the closure repeatedly until the predicate returns false. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ClosureUtils()
Method Detail |
public static Closure exceptionClosure()
public static Closure nopClosure()
public static Closure asClosure(Transformer transformer)
transformer
- the transformer to run each time in the closure, null means noppublic static Closure forClosure(int count, Closure closure)
count
times.
A null closure or zero count returns the NOPClosure
.
count
- the number of times to loopclosure
- the closure to call repeatedlyfor
closurepublic static Closure whileClosure(Predicate predicate, Closure closure)
predicate
- the predicate to use as an end of loop test, not nullclosure
- the closure to call repeatedly, not nullwhile
closureIllegalArgumentException
- if either argument is nullpublic static Closure doWhileClosure(Closure closure, Predicate predicate)
closure
- the closure to call repeatedly, not nullpredicate
- the predicate to use as an end of loop test, not nulldo-while
closureIllegalArgumentException
- if either argument is nullpublic static Closure invokerClosure(String methodName)
methodName
- the name of the methodinvoker
closureIllegalArgumentException
- if the method name is nullpublic static Closure invokerClosure(String methodName, Class[] paramTypes, Object[] args)
methodName
- the name of the methodparamTypes
- the parameter typesargs
- the argumentsinvoker
closureIllegalArgumentException
- if the method name is nullIllegalArgumentException
- if the paramTypes and args don't matchpublic static Closure chainedClosure(Closure closure1, Closure closure2)
closure1
- the first closureclosure2
- the second closurechained
closureIllegalArgumentException
- if either closure is nullpublic static Closure chainedClosure(Closure[] closures)
closures
- an array of closures to chainchained
closureIllegalArgumentException
- if the closures array is nullIllegalArgumentException
- if any closure in the array is nullpublic static Closure chainedClosure(Collection closures)
closures
- a collection of closures to chainchained
closureIllegalArgumentException
- if the closures collection is nullIllegalArgumentException
- if the closures collection is emptyIllegalArgumentException
- if any closure in the collection is nullpublic static Closure ifClosure(Predicate predicate, Closure trueClosure, Closure falseClosure)
predicate
- the predicate to switch ontrueClosure
- the closure called if the predicate is truefalseClosure
- the closure called if the predicate is falseswitch
closureIllegalArgumentException
- if the predicate is nullIllegalArgumentException
- if either closure is nullpublic static Closure switchClosure(Predicate[] predicates, Closure[] closures)
The closure at array location 0 is called if the predicate at array location 0 returned true. Each predicate is evaluated until one returns true.
predicates
- an array of predicates to check, not nullclosures
- an array of closures to call, not nullswitch
closureIllegalArgumentException
- if the either array is nullIllegalArgumentException
- if any element in the arrays is nullIllegalArgumentException
- if the arrays are different sizespublic static Closure switchClosure(Predicate[] predicates, Closure[] closures, Closure defaultClosure)
The closure at array location 0 is called if the predicate at array location 0 returned true. Each predicate is evaluated until one returns true. If no predicates evaluate to true, the default closure is called.
predicates
- an array of predicates to check, not nullclosures
- an array of closures to call, not nulldefaultClosure
- the default to call if no predicate matchesswitch
closureIllegalArgumentException
- if the either array is nullIllegalArgumentException
- if any element in the arrays is nullIllegalArgumentException
- if the arrays are different sizespublic static Closure switchClosure(Map predicatesAndClosures)
The Map consists of Predicate keys and Closure values. A closure is called if its matching predicate returns true. Each predicate is evaluated until one returns true. If no predicates evaluate to true, the default closure is called. The default closure is set in the map with a null key. The ordering is that of the iterator() method on the entryset collection of the map.
predicatesAndClosures
- a map of predicates to closuresswitch
closureIllegalArgumentException
- if the map is nullIllegalArgumentException
- if the map is emptyIllegalArgumentException
- if any closure in the map is nullClassCastException
- if the map elements are of the wrong typepublic static Closure switchMapClosure(Map objectsAndClosures)
The Map consists of object keys and Closure values. A closure is called if the input object equals the key. If there is no match, the default closure is called. The default closure is set in the map using a null key.
objectsAndClosures
- a map of objects to closuresIllegalArgumentException
- if the map is nullIllegalArgumentException
- if the map is emptyIllegalArgumentException
- if any closure in the map is null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |