Package org.apache.tools.ant.taskdefs
Class Exit
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Exit
- All Implemented Interfaces:
java.lang.Cloneable
public class Exit extends Task
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
-
Field Summary
-
Constructor Summary
Constructors Constructor Description Exit() -
Method Summary
Modifier and Type Method Description voidaddText(java.lang.String msg)Set a multiline message.ConditionBasecreateCondition()Add a condition element.voidexecute()Throw aBuildExceptionto exit (fail) the build.voidsetIf(java.lang.Object c)Only fail if the given expression evaluates to true or the name of an existing property.voidsetIf(java.lang.String c)Only fail if the given expression evaluates to true or the name of an existing property.voidsetMessage(java.lang.String value)A message giving further information on why the build exited.voidsetStatus(int i)Set the status code to associate with the thrown Exception.voidsetUnless(java.lang.Object c)Only fail if the given expression evaluates to false or tno property of the given name exists.voidsetUnless(java.lang.String c)Only fail if the given expression evaluates to false or tno property of the given name exists.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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
Exit
public Exit()
-
-
Method Details
-
setMessage
public void setMessage(java.lang.String value)A message giving further information on why the build exited.- Parameters:
value- message to output
-
setIf
public void setIf(java.lang.Object c)Only fail if the given expression evaluates to true or the name of an existing property.- Parameters:
c- property name or evaluated expression- Since:
- Ant 1.8.0
-
setIf
public void setIf(java.lang.String c)Only fail if the given expression evaluates to true or the name of an existing property.- Parameters:
c- property name or evaluated expression
-
setUnless
public void setUnless(java.lang.Object c)Only fail if the given expression evaluates to false or tno property of the given name exists.- Parameters:
c- property name or evaluated expression- Since:
- Ant 1.8.0
-
setUnless
public void setUnless(java.lang.String c)Only fail if the given expression evaluates to false or tno property of the given name exists.- Parameters:
c- property name or evaluated expression
-
setStatus
public void setStatus(int i)Set the status code to associate with the thrown Exception.- Parameters:
i- theintstatus
-
execute
Throw aBuildExceptionto exit (fail) the build. If specified, evaluate conditions: A single nested condition is accepted, but requires that theif/unlessattributes 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).- Overrides:
executein classTask- Throws:
BuildException- on error
-
addText
public void addText(java.lang.String msg)Set a multiline message.- Parameters:
msg- the message to display
-
createCondition
Add a condition element.- Returns:
ConditionBase.- Since:
- Ant 1.6.2
-