org.apache.tools.ant.taskdefs
public class Exit extends Task
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
UNKNOWN: name="fail" category="control"
Method Summary | |
---|---|
void | addText(String msg)
Set a multiline message. |
ConditionBase | createCondition()
Add a condition element. |
void | execute()
Throw a BuildException to exit (fail) the build.
|
void | setIf(String c)
Only fail if a property of the given name exists in the current project. |
void | setMessage(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(String c)
Only fail if a property of the given name does not
exist in the current project. |
Parameters: msg the message to display
Returns: ConditionBase
.
Since: Ant 1.6.2
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
Parameters: c property name
Parameters: value message to output
Parameters: i the int
status
Parameters: c property name