|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--org.apache.tools.ant.ProjectComponent
|
+--org.apache.tools.ant.Task
|
+--org.apache.tools.ant.taskdefs.Exit
Exits the active build, giving an additional message
if available.
The if and unless attributes make the
failure conditional -both probe for the named property being defined.
The if tests for the property being defined, the
unless for a property being undefined.
If both attributes are set, then the test fails only if both tests
are true. i.e.
fail := defined(ifProperty) && !defined(unlessProperty)A single nested
<condition> element can be specified
instead of using if/unless (a combined
effect can be achieved using isset conditions).
| Field Summary |
| Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
| Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
| Constructor Summary | |
Exit()
|
|
| Method Summary | |
void |
addText(java.lang.String msg)
Set a multiline message. |
ConditionBase |
createCondition()
Add a condition element. |
void |
execute()
Throw a BuildException to exit (fail) the build. |
void |
setIf(java.lang.String c)
Only fail if a property of the given name exists in the current project. |
void |
setMessage(java.lang.String value)
A message giving further information on why the build exited. |
void |
setStatus(int i)
Set the status code to associate with the thrown Exception. |
void |
setUnless(java.lang.String c)
Only fail if a property of the given name does not exist in the current project. |
| Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
| Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public Exit()
| Method Detail |
public void setMessage(java.lang.String value)
value - message to outputpublic void setIf(java.lang.String c)
c - property namepublic void setUnless(java.lang.String c)
c - property namepublic void setStatus(int i)
i - the int status
public void execute()
throws BuildException
BuildException to exit (fail) the build.
If specified, evaluate conditions:
A single nested condition is accepted, but requires that the
if/unless attributes be omitted.
If the nested condition evaluates to true, or the
ifCondition is true or unlessCondition is false, the build will exit.
The error message is constructed from the text fields, from
the nested condition (if specified), or finally from
the if and unless parameters (if present).
execute in class TaskBuildExceptionpublic void addText(java.lang.String msg)
msg - the message to displaypublic ConditionBase createCondition()
ConditionBase.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||