| org.apache.tools.ant.Task
 org.apache.tools.ant.taskdefs.optional.EchoProperties
| EchoProperties | | public class EchoProperties extends Task (Code) | | Displays all the current properties in the build. The output can be sent to
a file if desired.
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 |
| Method Summary | |
| public void | addPropertyset(PropertySet ps)
A set of properties to write. | | public 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. | | public void | setDestfile(File destfile)
Set a file to store the property output. | | public void | setFailOnError(boolean failonerror)
If true, the task will fail if an error occurs writing the properties
file, otherwise errors are just logged. | | public void | setFormat(FormatAttribute ea)
Set the output format - xml or text. | | public void | setPrefix(String prefix)
If the prefix is set, then only properties which start with this
prefix string will be recorded. | | public void | setRegex(String regex)
If the regex is set, then only properties whose names match it
will be recorded. | | public void | setSrcfile(File file)
Sets the input file. | | protected void | xmlSaveProperties(Properties props, OutputStream os)
Output the properties as xml output. |
| addPropertyset | | public void addPropertyset(PropertySet ps)(Code) | | A set of properties to write.
Parameters:
ps - the property set to write
since:
Ant 1.6 |
| jdkSaveProperties | | protected void jdkSaveProperties(Properties props, OutputStream os, String header) throws IOException(Code) | | JDK 1.2 allows for the safer method
Properties.store(OutputStream, String), which throws an
IOException on an output error.
Parameters:
props - the properties to record
Parameters:
os - record the properties to this output stream
Parameters:
header - prepend this header to the property output
exception:
IOException - on an I/O error during a write. |
| saveProperties | | protected void saveProperties(Hashtable allProps, OutputStream os) throws IOException, BuildException(Code) | | Send the key/value pairs in the hashtable to the given output stream.
Only those properties matching the prefix constraint will be
sent to the output stream.
The output stream will be closed when this method returns.
Parameters:
allProps - propfile to save
Parameters:
os - output stream
throws:
IOException - on output errors
throws:
BuildException - on other errors |
| setDestfile | | public void setDestfile(File destfile)(Code) | | Set a file to store the property output. If this is never specified,
then the output will be sent to the Ant log.
Parameters:
destfile - file to store the property output |
| setFailOnError | | public void setFailOnError(boolean failonerror)(Code) | | If true, the task will fail if an error occurs writing the properties
file, otherwise errors are just logged.
Parameters:
failonerror - true if IO exceptions are reported as buildexceptions, or false if IO exceptions are ignored. |
| setFormat | | public void setFormat(FormatAttribute ea)(Code) | | Set the output format - xml or text.
Parameters:
ea - an enumerated FormatAttribute value |
| setPrefix | | public void setPrefix(String prefix)(Code) | | If the prefix is set, then only properties which start with this
prefix string will be recorded. If regex is not set and if this
is never set, or it is set to an empty string or null,
then all properties will be recorded.
For example, if the attribute 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 |
| setRegex | | public void setRegex(String regex)(Code) | | If the regex is set, then only properties whose names match it
will be recorded. If prefix is not set and if this is never set,
or it is set to an empty string or null, then all
properties will be recorded.
For example, if the attribute is set as:
<echoproperties prefix=".*ant.*" />
then the properties "ant.home" and "user.variant" will be recorded,
but "ant-example" will not.
Parameters:
regex - The new regex value
since:
Ant 1.7 |
| setSrcfile | | public void setSrcfile(File file)(Code) | | Sets the input file.
Parameters:
file - the input file |
| xmlSaveProperties | | protected void xmlSaveProperties(Properties props, OutputStream os) throws IOException(Code) | | Output the properties as xml output.
Parameters:
props - the properties to save
Parameters:
os - the output stream to write to (Note this gets closed)
throws:
IOException - on error in writing to the stream |
|
|