peterreilly 2005/03/14 07:31:35
Modified: src/main/org/apache/tools/ant/taskdefs/optional
EchoProperties.java
Log:
javadoc
Revision Changes Path
1.31 +22 -4
ant/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java
Index: EchoProperties.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- EchoProperties.java 10 Mar 2005 21:16:08 -0000 1.30
+++ EchoProperties.java 14 Mar 2005 15:31:34 -0000 1.31
@@ -177,20 +177,31 @@
/**
* A set of properties to write.
- *
+ * @param ps the property set to write
* @since Ant 1.6
*/
public void addPropertyset(PropertySet ps) {
propertySets.addElement(ps);
}
+ /**
+ * Set the output format - xml or text.
+ * @param ea an enumerated <code>FormatAttribute</code> value
+ */
public void setFormat(FormatAttribute ea) {
format = ea.getValue();
}
+ /**
+ * A enumerated type for the format attribute.
+ * The values are "xml" and "text".
+ */
public static class FormatAttribute extends EnumeratedAttribute {
private String [] formats = new String[]{"xml", "text"};
+ /**
+ * @see EnumeratedAttribute#getValues()
+ */
public String[] getValues() {
return formats;
}
@@ -320,9 +331,10 @@
* sent to the output stream.
* The output stream will be closed when this method returns.
*
- [EMAIL PROTECTED] allProps propfile to save
- [EMAIL PROTECTED] os output stream
- [EMAIL PROTECTED] IOException trouble
+ * @param allProps propfile to save
+ * @param os output stream
+ * @throws IOException on output errors
+ * @throws BuildException on other errors
*/
protected void saveProperties(Hashtable allProps, OutputStream os)
throws IOException, BuildException {
@@ -383,6 +395,12 @@
return sorted;
}
+ /**
+ * Output the properties as xml output.
+ * @param props the properties to save
+ * @param os the output stream to write to (Note this gets closed)
+ * @throws IOException on error in writing to the stream
+ */
protected void xmlSaveProperties(Properties props,
OutputStream os) throws IOException {
// create XML document
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
