org.apache.tools.ant.taskdefs.optional
public class EchoProperties extends Task
Attribute "destfile" defines a file to send the properties to. This can be processed as a standard property file later.
Attribute "prefix" defines a prefix which is used to filter the properties only those properties starting with this prefix will be echoed.
By default, the "failonerror" attribute is enabled. If an error occurs while writing the properties to a file, and this attribute is enabled, then a BuildException will be thrown. If disabled, then IO errors will be reported as a log statement, but no error will be thrown.
Examples:
<echoproperties />Report the current properties to the log.
<echoproperties destfile="my.properties" />Report the current properties to the file "my.properties", and will fail the build if the file could not be created or written to.
<echoproperties destfile="my.properties" failonerror="false" prefix="ant" />Report all properties beginning with 'ant' to the file "my.properties", and will log a message if the file could not be created or written to, but will still allow the build to continue.
Since: Ant 1.5
Nested Class Summary | |
---|---|
static class | EchoProperties.FormatAttribute |
Method Summary | |
---|---|
void | addPropertyset(PropertySet ps)
A set of properties to write.
|
void | execute()
Run the task.
|
protected void | jdkSaveProperties(Properties props, OutputStream os, String header)
JDK 1.2 allows for the safer method
Properties.store(OutputStream, String), which throws an
IOException on an output error.
|
protected void | saveProperties(Hashtable allProps, OutputStream os)
Send the key/value pairs in the hashtable to the given output stream.
|
void | setDestfile(File destfile)
Set a file to store the property output. |
void | setFailOnError(boolean failonerror)
If true, the task will fail if an error occurs writing the properties
file, otherwise errors are just logged.
|
void | setFormat(EchoProperties.FormatAttribute ea) |
void | setPrefix(String prefix)
If the prefix is set, then only properties which start with this
prefix string will be recorded. |
void | setSrcfile(File file)
Sets the input file.
|
protected void | xmlSaveProperties(Properties props, OutputStream os) |
Since: Ant 1.6
Throws: BuildException trouble, probably file IO
Parameters: props the properties to record os record the properties to this output stream header prepend this header to the property output
Throws: IOException on an I/O error during a write.
Parameters: allProps propfile to save os output stream
Throws: IOException trouble
Parameters: destfile file to store the property output
Parameters: failonerror true if IO exceptions are reported as build exceptions, or false if IO exceptions are ignored.
For example, if the property is set as:
<echoproperties prefix="ant." />then the property "ant.home" will be recorded, but "ant-example" will not.
Parameters: prefix The new prefix value
Parameters: file the input file