|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.ClosureUtils
public class ClosureUtils
ClosureUtils
provides reference implementations and utilities
for the Closure functor interface. The supplied closures are:
Method Summary | ||
---|---|---|
static
|
asClosure(Transformer<? super E,?> transformer)
Creates a Closure that calls a Transformer each time it is called. |
|
static
|
chainedClosure(Closure<? super E>... closures)
Create a new Closure that calls each closure in turn, passing the result into the next closure. |
|
static
|
chainedClosure(Collection<Closure<E>> closures)
Create a new Closure that calls each closure in turn, passing the result into the next closure. |
|
static
|
doWhileClosure(Closure<? super E> closure,
Predicate<? super E> predicate)
Creates a Closure that will call the closure once and then repeatedly until the predicate returns false. |
|
static
|
exceptionClosure()
Gets a Closure that always throws an exception. |
|
static
|
forClosure(int count,
Closure<? super E> closure)
Creates a Closure that will call the closure count times. |
|
static
|
ifClosure(Predicate<? super E> predicate,
Closure<? super E> trueClosure)
Create a new Closure that calls another closure based on the result of the specified predicate. |
|
static
|
ifClosure(Predicate<? super E> predicate,
Closure<? super E> trueClosure,
Closure<? super E> falseClosure)
Create a new Closure that calls one of two closures depending on the specified predicate. |
|
static
|
invokerClosure(String methodName)
Creates a Closure that will invoke a specific method on the closure's input object by reflection. |
|
static
|
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
|
nopClosure()
Gets a Closure that will do nothing. |
|
static
|
switchClosure(Map<Predicate<E>,Closure<E>> predicatesAndClosures)
Create a new Closure that calls one of the closures depending on the predicates. |
|
static
|
switchClosure(Predicate<? super E>[] predicates,
Closure<? super E>[] closures)
Create a new Closure that calls one of the closures depending on the predicates. |
|
static
|
switchClosure(Predicate<? super E>[] predicates,
Closure<? super E>[] closures,
Closure<? super E> defaultClosure)
Create a new Closure that calls one of the closures depending on the predicates. |
|
static
|
switchMapClosure(Map<? extends E,Closure<E>> objectsAndClosures)
Create a new Closure that uses the input object as a key to find the closure to call. |
|
static
|
whileClosure(Predicate<? super E> predicate,
Closure<? super E> 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 |
Method Detail |
---|
public static <E> Closure<E> exceptionClosure()
E
- the type that the closure acts on
ExceptionClosure
public static <E> Closure<E> nopClosure()
E
- the type that the closure acts on
NOPClosure
public static <E> Closure<E> asClosure(Transformer<? super E,?> transformer)
E
- the type that the closure acts ontransformer
- the transformer to run each time in the closure, null means nop
TransformerClosure
public static <E> Closure<E> forClosure(int count, Closure<? super E> closure)
count
times.
A null closure or zero count returns the NOPClosure
.
E
- the type that the closure acts oncount
- the number of times to loopclosure
- the closure to call repeatedly
for
closureForClosure
public static <E> Closure<E> whileClosure(Predicate<? super E> predicate, Closure<? super E> closure)
E
- the type that the closure acts onpredicate
- the predicate to use as an end of loop test, not nullclosure
- the closure to call repeatedly, not null
while
closure
IllegalArgumentException
- if either argument is nullWhileClosure
public static <E> Closure<E> doWhileClosure(Closure<? super E> closure, Predicate<? super E> predicate)
E
- the type that the closure acts onclosure
- the closure to call repeatedly, not nullpredicate
- the predicate to use as an end of loop test, not null
do-while
closure
IllegalArgumentException
- if either argument is nullWhileClosure
public static <E> Closure<E> invokerClosure(String methodName)
E
- the type that the closure acts onmethodName
- the name of the method
invoker
closure
IllegalArgumentException
- if the method name is nullInvokerTransformer
,
TransformerClosure
public static <E> Closure<E> invokerClosure(String methodName, Class<?>[] paramTypes, Object[] args)
E
- the type that the closure acts onmethodName
- the name of the methodparamTypes
- the parameter typesargs
- the arguments
invoker
closure
IllegalArgumentException
- if the method name is null
IllegalArgumentException
- if the paramTypes and args don't matchInvokerTransformer
,
TransformerClosure
public static <E> Closure<E> chainedClosure(Closure<? super E>... closures)
E
- the type that the closure acts onclosures
- an array of closures to chain
chained
closure
IllegalArgumentException
- if the closures array is null
IllegalArgumentException
- if any closure in the array is nullChainedClosure
public static <E> Closure<E> chainedClosure(Collection<Closure<E>> closures)
E
- the type that the closure acts onclosures
- a collection of closures to chain
chained
closure
IllegalArgumentException
- if the closures collection is null
IllegalArgumentException
- if the closures collection is empty
IllegalArgumentException
- if any closure in the collection is nullChainedClosure
public static <E> Closure<E> ifClosure(Predicate<? super E> predicate, Closure<? super E> trueClosure)
E
- the type that the closure acts onpredicate
- the validating predicatetrueClosure
- the closure called if the predicate is true
if
closure
IllegalArgumentException
- if the predicate is null
IllegalArgumentException
- if the closure is nullIfClosure
public static <E> Closure<E> ifClosure(Predicate<? super E> predicate, Closure<? super E> trueClosure, Closure<? super E> falseClosure)
E
- the type that the closure acts onpredicate
- the predicate to switch ontrueClosure
- the closure called if the predicate is truefalseClosure
- the closure called if the predicate is false
switch
closure
IllegalArgumentException
- if the predicate is null
IllegalArgumentException
- if either closure is nullIfClosure
public static <E> Closure<E> switchClosure(Predicate<? super E>[] predicates, Closure<? super E>[] 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.
E
- the type that the closure acts onpredicates
- an array of predicates to check, not nullclosures
- an array of closures to call, not null
switch
closure
IllegalArgumentException
- if the either array is null
IllegalArgumentException
- if any element in the arrays is null
IllegalArgumentException
- if the arrays are different sizesSwitchClosure
public static <E> Closure<E> switchClosure(Predicate<? super E>[] predicates, Closure<? super E>[] closures, Closure<? super E> 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.
E
- the type that the closure acts onpredicates
- an array of predicates to check, not nullclosures
- an array of closures to call, not nulldefaultClosure
- the default to call if no predicate matches
switch
closure
IllegalArgumentException
- if the either array is null
IllegalArgumentException
- if any element in the arrays is null
IllegalArgumentException
- if the arrays are different sizesSwitchClosure
public static <E> Closure<E> switchClosure(Map<Predicate<E>,Closure<E>> 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.
E
- the type that the closure acts onpredicatesAndClosures
- a map of predicates to closures
switch
closure
IllegalArgumentException
- if the map is null
IllegalArgumentException
- if the map is empty
IllegalArgumentException
- if any closure in the map is null
ClassCastException
- if the map elements are of the wrong typeSwitchClosure
public static <E> Closure<E> switchMapClosure(Map<? extends E,Closure<E>> 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.
E
- the type that the closure acts onobjectsAndClosures
- a map of objects to closures
IllegalArgumentException
- if the map is null
IllegalArgumentException
- if the map is empty
IllegalArgumentException
- if any closure in the map is nullSwitchClosure
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |