rdonkin 2003/12/03 15:36:13
Modified: digester/src/java/org/apache/commons/digester
Substitutor.java
Log:
Improved javadocs
Revision Changes Path
1.2 +17 -6
jakarta-commons/digester/src/java/org/apache/commons/digester/Substitutor.java
Index: Substitutor.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/digester/src/java/org/apache/commons/digester/Substitutor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Substitutor.java 2 Dec 2003 23:21:16 -0000 1.1
+++ Substitutor.java 3 Dec 2003 23:36:13 -0000 1.2
@@ -83,8 +83,19 @@
public abstract class Substitutor {
/**
- * Substitutes the attributes (before they are passed to the
- * <code>Rule</code> implementations's)
+ * <p>Substitutes the attributes (before they are passed to the
+ * <code>Rule</code> implementations's).</p>
+ *
+ * <p><code>Digester</code> will only call this method a second time
+ * once the original <code>Attributes</code> instance can be safely reused.
+ * The implementation is therefore free to reuse the same
<code>Attributes</code> instance
+ * for all calls.</p>
+ *
+ * @param attributes the <code>Attributes</code> passed into
<code>Digester</code> by the SAX parser,
+ * not null (but may be empty)
+ * @return <code>Attributes</code> to be passed to the <code>Rule</code>
implementations.
+ * This method may pass back the Attributes passed in.
+ * Not null but possibly empty.
*/
public abstract Attributes substitute(Attributes attributes);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
