Class ConditionTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.taskdefs.condition.ConditionBase

org.apache.tools.ant.taskdefs.ConditionTask

All Implemented Interfaces:

Cloneable

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 ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
ConditionTask()	Constructor, names this task "condition".

Method Summary

Modifier and Type	Method	Description
void	execute()	See whether our nested condition holds and set the property.
void	setElse(Object alt)	The value for the property to set, if condition evaluates to false.
void	setElse(String e)	The value for the property to set, if condition evaluates to false.
void	setProperty(String p)	The name of the property to set.
void	setValue(Object value)	The value for the property to set, if condition evaluates to true.
void	setValue(String v)	The value for the property to set, if condition evaluates to true.

Methods inherited from class ConditionBase

add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName

Modifier and Type	Method	Description
void	add(Condition c)	Add an arbitrary condition
void	addAnd(And a)	Add an <and> condition "container".
void	addAvailable(Available a)	Add an <available> condition.
void	addChecksum(Checksum c)	Add an <checksum> condition.
void	addContains(Contains test)	Add a <contains> condition.
void	addEquals(Equals e)	Add an <equals> condition.
void	addFilesMatch(FilesMatch test)	Add a <filesmatch> condition.
void	addHttp(Http h)	Add an <http> condition.
void	addIsFalse(IsFalse test)	Add a <isfalse> condition.
void	addIsFileSelected(IsFileSelected test)	Add an <isfileselected> condition.
void	addIsReference(IsReference i)	Add an <isreference> condition.
void	addIsSet(IsSet i)	Add an <isset> condition.
void	addIsTrue(IsTrue test)	Add a <istrue> condition.
void	addNot(Not n)	Add an <not> condition "container".
void	addOr(Or o)	Add an <or> condition "container".
void	addOs(Os o)	Add an <os> condition.
void	addSocket(Socket s)	Add a <socket> condition.
void	addUptodate(UpToDate u)	Add an <uptodate> condition.
protected int	countConditions()	Count the conditions.
protected final Enumeration<Condition>	getConditions()	Iterate through all conditions.
String	getTaskName()	Returns the name to use in logging messages.
void	setTaskName(String name)	Sets the name to use in logging messages.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConditionTask

public ConditionTask()

Constructor, names this task "condition".

Method Details

setProperty

public void setProperty(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(Object value)

The value for the property to set, if condition evaluates to true. Defaults to "true".

Parameters:

value - the (Object) value of the property

Since:

Ant 1.8

setValue

public void setValue(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(Object alt)

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:

alt - the alternate value of the property.

Since:

Ant 1.8

setElse

public void setElse(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