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. Theifandunlessattributes make the failure conditional -both probe for the named property being defined. Theiftests for the property being defined, theunlessfor 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 usingif/unless(a combined effect can be achieved usingissetconditions).- Since:
- Ant 1.2
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description Exit()
 - 
Method SummaryModifier 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.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Method Detail- 
setMessagepublic void setMessage(java.lang.String value) A message giving further information on why the build exited.- Parameters:
- value- message to output
 
 - 
setIfpublic 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
 
 - 
setIfpublic 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
 
 - 
setUnlesspublic 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
 
 - 
setUnlesspublic 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
 
 - 
setStatuspublic void setStatus(int i) Set the status code to associate with the thrown Exception.- Parameters:
- i- the- intstatus
 
 - 
executepublic void execute() throws BuildExceptionThrow 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 class- Task
- Throws:
- BuildException- on error
 
 - 
addTextpublic void addText(java.lang.String msg) Set a multiline message.- Parameters:
- msg- the message to display
 
 - 
createConditionpublic ConditionBase createCondition() Add a condition element.- Returns:
- ConditionBase.
- Since:
- Ant 1.6.2
 
 
- 
 
-