net.sf.antcontrib.property

Class Variable

public class Variable extends Task

Similar to Property, but this property is mutable. In fact, much of the code in this class is copy and paste from Property. In general, the standard Ant property should be used, but occasionally it is useful to use a mutable property.

This used to be a nice little task that took advantage of what is probably a flaw in the Ant Project API -- setting a "user" property programatically causes the project to overwrite a previously set property. Now this task has become more violent and employs a technique known as "object rape" to directly access the Project's private property hashtable.

Developed for use with Antelope, migrated to ant-contrib Oct 2003.

Since: Ant 1.5

Version: $Revision: 1.6 $

Author: Dale Anson, danson@germane-software.com

Method Summary
protected voidaddProperties(Properties props)
iterate through a set of properties, resolve them, then assign them
voidexecute()
Execute this task.
voidsetFile(File file)
Set the name of a file to read properties from.
voidsetName(String name)
Set the name of the property.
voidsetUnset(boolean b)
Determines whether the property should be removed from the project.
voidsetValue(String value)
Set the value of the property.

Method Detail

addProperties

protected void addProperties(Properties props)
iterate through a set of properties, resolve them, then assign them

Parameters: props The feature to be added to the Properties attribute

execute

public void execute()
Execute this task.

Throws: BuildException Description of the Exception

setFile

public void setFile(File file)
Set the name of a file to read properties from. Optional.

Parameters: file the file to read properties from.

setName

public void setName(String name)
Set the name of the property. Required unless 'file' is used.

Parameters: name the name of the property.

setUnset

public void setUnset(boolean b)
Determines whether the property should be removed from the project. Default is false. Once removed, conditions that check for property existence will find this property does not exist.

Parameters: b set to true to remove the property from the project.

setValue

public void setValue(String value)
Set the value of the property. Optional, defaults to "".

Parameters: value the value of the property.