it.haefelinger.flaka
Class TryCatch

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          it.haefelinger.flaka.TryCatch

All Implemented Interfaces:

Cloneable

public class TryCatch
extends Task

A wrapper that lets you run a set of tasks and optionally run a different set of tasks if the first set fails and yet another set after the first one has finished.

This mirrors Java's try/catch/finally.

The tasks inside of the required <try> element will be run. If one of them should throw a BuildException several things can happen:

• If there is no <catch> block, the exception will be passed through to Ant.
• If the property attribute has been set, a property of the given name will be set to the message of the exception.
• If the reference attribute has been set, a reference of the given id will be created and point to the exception object.
• If there is a <catch> block, the tasks nested into it will be run.

If a <finally> block is present, the task nested into it will be run, no matter whether the first tasks have thrown an exception or not.

Attributes:

Name	Description	Required
property	Name of a property that will receive the message of the exception that has been caught (if any)	No
reference	Id of a reference that will point to the exception object that has been caught (if any)	No

Use the following task to define the <trycatch> task before you use it the first time:

 <code>
   <taskdef name="trycatch" 
            classname="net.sf.antcontrib.logic.TryCatchTask" />
 </code>
 

Crude Example

 <code>
 <trycatch property="foo" reference="bar">
   <try>
     <fail>Tada!</fail>
   </try>
   <catch>
     <echo>In &lt;catch&gt;.</echo>
   </catch>
   <finally>
     <echo>In &lt;finally&gt;.</echo>
   </finally>
 </trycatch>
 <echo>As property: ${foo}</echo>
 <property name="baz" refid="bar" />
 <echo>From reference: ${baz}</echo>
 </code>
 

results in

 <code>
   [trycatch] Caught exception: Tada!
       [echo] In <catch>.
       [echo] In <finally>.
       [echo] As property: Tada!
       [echo] From reference: Tada!
 </code>
 

Since:

1.0

Author:

merzedes

Nested Class Summary

static class

TryCatch.CatchBlock A helper class implementing a catch clause.

Field Summary

protected List	catchlist
protected List	finallylist
protected String	property
protected String	reference
static String	REFERENCE
protected List	trylist

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

TryCatch()

Method Summary

void	addCatch(TryCatch.CatchBlock cb) Add a catch clause.
void	addFinally(Sequential seq) Adds a finally clause.
void	addTry(Sequential seq) A a sequential task container to the list of tries.
void	execute()
static void	main(String[] args)
protected void	saveit(Throwable e)
void	setProperty(String p) Sets the property attribute.
void	setReference(String r) Sets the reference attribute.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REFERENCE

public static final String REFERENCE

See Also:

Constant Field Values

trylist

protected List trylist

catchlist

protected List catchlist

finallylist

protected List finallylist

property

protected String property

reference

protected String reference

Constructor Detail

TryCatch

public TryCatch()

Method Detail

addTry

public void addTry(Sequential seq)

A a sequential task container to the list of tries.

Parameters:

seq -

addCatch

public void addCatch(TryCatch.CatchBlock cb)

Add a catch clause.

Parameters:

cb -

addFinally

public void addFinally(Sequential seq)

Adds a finally clause.

Parameters:

seq -

setProperty

public void setProperty(String p)

Sets the property attribute.

setReference

public void setReference(String r)

Sets the reference attribute.

saveit

protected void saveit(Throwable e)

execute

public void execute()
             throws BuildException

Overrides:

execute in class Task

Throws:

BuildException

main

public static void main(String[] args)