org.apache.tools.ant.taskdefs
Class ConditionTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.taskdefs.condition.ConditionBase
              |
              +--org.apache.tools.ant.taskdefs.ConditionTask

public class ConditionTask
extends ConditionBase

Task to set a property conditionally using <uptodate>, <available>, and many other supported conditions.

This task supports boolean logic as well as pluggable conditions to decide, whether a property should be set.

This task does not extend Task to take advantage of ConditionBase.

Since:
Ant 1.4

Field Summary
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
ConditionTask()
           
 
Method Summary
 void execute()
          See whether our nested condition holds and set the property.
 void setElse(java.lang.String e)
          The value for the property to set, if condition evaluates to false.
 void setProperty(java.lang.String p)
          The name of the property to set.
 void setValue(java.lang.String v)
          The value for the property to set, if condition evaluates to true.
 
Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, log, log, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConditionTask

public ConditionTask()
Method Detail

setProperty

public void setProperty(java.lang.String p)
The name of the property to set. Required.

Parameters:
p - the name of the property
Since:
Ant 1.4

setValue

public void setValue(java.lang.String v)
The value for the property to set, if condition evaluates to true. Defaults to "true".

Parameters:
v - the value of the property
Since:
Ant 1.4

setElse

public void setElse(java.lang.String e)
The value for the property to set, if condition evaluates to false. If this attribute is not specified, the property will not be set.

Parameters:
e - the alternate value of the property.
Since:
Ant 1.6.3

execute

public void execute()
             throws BuildException
See whether our nested condition holds and set the property.

Throws:
BuildException - if an error occurs
Since:
Ant 1.4


Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.