org.apache.commons.collections.functors
Class IfClosure

java.lang.Object
  |
  +--org.apache.commons.collections.functors.IfClosure
All Implemented Interfaces:
Closure, Serializable

public class IfClosure
extends Object
implements Closure, Serializable

Closure implementation acts as an if statement calling one or other closure based on a predicate.

Since:
Commons Collections 3.0
Version:
$Revision: 1.3 $ $Date: 2004/01/14 21:43:09 $
Author:
Stephen Colebourne
See Also:
Serialized Form

Constructor Summary
IfClosure(Predicate predicate, Closure trueClosure, Closure falseClosure)
          Constructor that performs no validation.
 
Method Summary
 void execute(Object input)
          Execute the correct closure.
static Closure getInstance(Predicate predicate, Closure trueClosure, Closure falseClosure)
          Factory method that performs validation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IfClosure

public IfClosure(Predicate predicate,
                 Closure trueClosure,
                 Closure falseClosure)
Constructor that performs no validation. Use getInstance if you want that.
Parameters:
predicate - predicate to switch on, not null
trueClosure - closure used if true, not null
falseClosure - closure used if false, not null
Method Detail

getInstance

public static Closure getInstance(Predicate predicate,
                                  Closure trueClosure,
                                  Closure falseClosure)
Factory method that performs validation.
Parameters:
predicate - predicate to switch on
trueClosure - closure used if true
falseClosure - closure used if false
Returns:
the if closure
Throws:
IllegalArgumentException - if any argument is null

execute

public void execute(Object input)
Execute the correct closure.
Specified by:
execute in interface Closure
Following copied from interface: org.apache.commons.collections.Closure
Parameters:
input - the input to execute on
Throws:
ClassCastException - (runtime) if the input is the wrong class
IllegalArgumentException - (runtime) if the input is invalid
FunctorException - (runtime) if any other error occurs


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