Package ise.antelope.tasks
Class IfTask
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.Task
-
- ise.antelope.tasks.IfTask
-
- All Implemented Interfaces:
Breakable
,java.lang.Cloneable
,org.apache.tools.ant.TaskContainer
public class IfTask extends org.apache.tools.ant.Task implements org.apache.tools.ant.TaskContainer, Breakable
Similar to Java's 'if' keyword, verifies that a given property has a given value and executes embedded tasks if it does. Does nothing if the property value is not as expected or the property does not exist.Can hold other tasks including IfTask, in particular, an ElseTask and a Break.
- Since:
- Ant 1.5
-
-
Constructor Summary
Constructors Constructor Description IfTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addBool(BooleanConditionTask boolTask)
void
addBreak(Break b)
Required by Breakable.void
addElse(ElseTask elseTask)
void
addTask(org.apache.tools.ant.Task task)
Add a nested task to execute.boolean
doBreak()
Required by Breakable.void
execute()
Execute this task and all nested Tasks, checking for Breaks and Breakables.void
init()
Automatically define dependent tasks.void
maybeConfigure()
OverridemaybeConfigure
in a way that leaves the nested tasks unconfigured until they get executed.void
setBreak(boolean b)
Required by Breakable.void
setExists(java.lang.String exists)
Set the 'exists' attribute.void
setName(java.lang.String name)
Set the name of the property to test.void
setValue(java.lang.String value)
Set the expected value of the property.-
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
-
-
-
-
Method Detail
-
init
public void init()
Automatically define dependent tasks.- Overrides:
init
in classorg.apache.tools.ant.Task
-
setName
public void setName(java.lang.String name)
Set the name of the property to test. Required unless nested condition is used.- Parameters:
name
- the name of the property to test.
-
setValue
public void setValue(java.lang.String value)
Set the expected value of the property. Implies 'exists'.execute
method throws BuildException if the actual value is not the same as this value. Optional.- Parameters:
value
- the expected value of the property.
-
setExists
public void setExists(java.lang.String exists)
Set the 'exists' attribute. If true, throws BuildException if the property does not exist. Optional, default is true.- Parameters:
exists
- Ant boolean, whether the value must exist.
-
setBreak
public void setBreak(boolean b)
Required by Breakable.
-
addBreak
public void addBreak(Break b)
Required by Breakable.
-
addElse
public void addElse(ElseTask elseTask)
-
addBool
public void addBool(BooleanConditionTask boolTask)
-
doBreak
public boolean doBreak()
Required by Breakable.
-
maybeConfigure
public void maybeConfigure() throws org.apache.tools.ant.BuildException
OverridemaybeConfigure
in a way that leaves the nested tasks unconfigured until they get executed.- Overrides:
maybeConfigure
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
- Description of the Exception- Since:
- Ant 1.5
-
addTask
public void addTask(org.apache.tools.ant.Task task)
Add a nested task to execute.- Specified by:
addTask
in interfaceorg.apache.tools.ant.TaskContainer
- Parameters:
task
- Nested task to execute.
-
execute
public void execute() throws org.apache.tools.ant.BuildException
Execute this task and all nested Tasks, checking for Breaks and Breakables.- Overrides:
execute
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
- Description of the Exception
-
-