org.apache.tools.ant.taskdefs.optional

Class PropertyFile


public class PropertyFile
extends Task

Modifies settings in a property file.

The following is an example of its usage:

</target>

The <propertyfile> task must have:

Other parameters are:
The <entry> task must have:
Other parameters are:
If type is unspecified, it defaults to string Parameter values:
  • value:
  • 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

    static class
    PropertyFile.Entry
    Instance of this class represents nested elements of a task propertyfile.
    static class
    PropertyFile.Unit
    Borrowed from Tstamp

    Field Summary

    Fields inherited from class org.apache.tools.ant.Task

    description, location, target, taskName, taskType, wrapper

    Fields inherited from class org.apache.tools.ant.ProjectComponent

    project

    Method Summary

    PropertyFile.Entry
    createEntry()
    void
    execute()
    Called by the project to let the task do its work.
    void
    setComment(String hdr)
    optional header comment for the file
    void
    setFile(File file)
    Location of the property file to be edited; required.

    Methods inherited from class org.apache.tools.ant.Task

    execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

    Methods inherited from class org.apache.tools.ant.ProjectComponent

    getProject, log, log, setProject

    Method Details

    createEntry

    public PropertyFile.Entry createEntry()

    execute

    public void execute()
                throws BuildException
    Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.
    Overrides:
    execute in interface Task
    Throws:
    BuildException - if something goes wrong with the build

    setComment

    public void setComment(String hdr)
    optional header comment for the file

    setFile

    public void setFile(File file)
    Location of the property file to be edited; required.

    Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.