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).Constructor and Description |
---|
Exit() |
Modifier and Type | Method and Description |
---|---|
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(Object c)
Only fail if the given expression evaluates to true or the name
of an existing property.
|
void |
setIf(String c)
Only fail if the given expression evaluates to true or the name
of an existing property.
|
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(Object c)
Only fail if the given expression evaluates to false or tno
property of the given name exists.
|
void |
setUnless(String c)
Only fail if the given expression evaluates to false or tno
property of the given name exists.
|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
public void addText(String msg)
msg
- the message to displaypublic ConditionBase createCondition()
ConditionBase
.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 Task
BuildException
- on errorpublic void setIf(Object c)
c
- property name or evaluated expressionpublic void setIf(String c)
c
- property name or evaluated expressionpublic void setMessage(String value)
value
- message to outputpublic void setStatus(int i)
i
- the int
statuspublic void setUnless(Object c)
c
- property name or evaluated expressionpublic void setUnless(String c)
c
- property name or evaluated expression