| org.apache.tools.ant.Task
 org.apache.tools.ant.taskdefs.Exit
| Exit | | public class Exit extends Task (Code) | | 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).
since:
Ant 1.2 |
| Method Summary | |
| public void | addText(String msg)
Set a multiline message. | | public ConditionBase | createCondition()
Add a condition element. | | public void | execute()
Throw a BuildException to exit (fail) the build. | | public void | setIf(String c)
Only fail if a property of the given name exists in the current project. | | public void | setMessage(String value)
A message giving further information on why the build exited. | | public void | setStatus(int i)
Set the status code to associate with the thrown Exception. | | public void | setUnless(String c)
Only fail if a property of the given name does not
exist in the current project. |
| addText | | public void addText(String msg)(Code) | | Set a multiline message.
Parameters:
msg - the message to display |
| createCondition | | public ConditionBase createCondition()(Code) | | Add a condition element.
ConditionBase.
since:
Ant 1.6.2 |
| execute | | public void execute() throws BuildException(Code) | | Throw a 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).
throws:
BuildException - on error |
| setIf | | public void setIf(String c)(Code) | | Only fail if a property of the given name exists in the current project.
Parameters:
c - property name |
| setMessage | | public void setMessage(String value)(Code) | | A message giving further information on why the build exited.
Parameters:
value - message to output |
| setStatus | | public void setStatus(int i)(Code) | | Set the status code to associate with the thrown Exception.
Parameters:
i - the int status |
| setUnless | | public void setUnless(String c)(Code) | | Only fail if a property of the given name does not
exist in the current project.
Parameters:
c - property name |
|
|