Home » apache-ant-1.7.1-src » org.apache.tools » ant » taskdefs » optional » [javadoc | source]

org.apache.tools.ant.taskdefs.optional
public class: PropertyFile [javadoc | source]

java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.tools.ant.taskdefs.optional.PropertyFile

All Implemented Interfaces:
    Cloneable

Modifies settings in a property file.

The following is an example of its usage:

<target name="setState">

<property

name="header"
value="##Generated file - do not modify!"/>
<propertyfile file="apropfile.properties" comment="${header}">
<entry key="product.version.major" type="int" value="5"/>
<entry key="product.version.minor" type="int" value="0"/>
<entry key="product.build.major" type="int" value="0" />
<entry key="product.build.minor" type="int" operation="+" />
<entry key="product.build.date" type="date" value="now" />
<entry key="intSet" type="int" operation="=" value="681"/>
<entry key="intDec" type="int" operation="-"/>
<entry key="StringEquals" type="string" value="testValue"/>
</propertyfile>

</target>

The <propertyfile> task must have:


• file
Other parameters are:

• comment, key, operation, type and value (the final four being eliminated shortly)
The <entry> task must have:

• key
Other parameters are:

• operation
• type
• value
• default
• unit
If type is unspecified, it defaults to string Parameter values:

• operation:
• "=" (set -- default)
• "-" (dec)
• "+" (inc)
• type:
• "int"
• "date"
• "string"
• value:
• holds the default value, if the property was not found in property file
• "now" In case of type "date", the value "now" will be replaced by the current date/time and used even if a valid date was found in the property file.
String property types can only use the "=" operation. Int property types can only use the "=", "-" or "+" operations.

The message property is used for the property file header, with "\\" being a newline delimiter character.

Nested Class Summary:
public static class	PropertyFile.Entry	Instance of this class represents nested elements of a task propertyfile.
public static class	PropertyFile.Unit	Borrowed from Tstamp

Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper

Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description

Method from org.apache.tools.ant.taskdefs.optional.PropertyFile Summary:
createEntry,   execute,   setComment,   setFile

Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType

Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.tools.ant.taskdefs.optional.PropertyFile Detail:
public PropertyFile.Entry createEntry() { Entry e = new Entry(); entries.addElement(e); return e; } The entry nested element.
public void execute() throws BuildException { /* ======================================================================== * * Constructors */ /* ======================================================================== * * Methods */ checkParameters(); readFile(); executeOperation(); writeFile(); } Execute the task.
public void setComment(String hdr) { comment = hdr; } optional header comment for the file
public void setFile(File file) { propertyfile = file; } Location of the property file to be edited; required.