svn commit: r155171 - jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/plugins/RuleLoader.java

[sk...@apache.org]

Author: skitching
Date: Wed Feb 23 20:24:09 2005
New Revision: 155171

URL: http://svn.apache.org/viewcvs?view=rev&rev=155171
Log:
Clarify javadoc for addRules method.

Modified:
    jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/plugins/RuleLoader.java

Modified: jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/plugins/RuleLoader.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/plugins/RuleLoader.java?view=diff&r1=155170&r2=155171
==============================================================================
--- jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/plugins/RuleLoader.java (original)
+++ jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/plugins/RuleLoader.java Wed Feb 23 20:24:09 2005
@@ -42,6 +42,11 @@
      * This method is invoked when the start of an xml tag is encountered
      * which maps to a PluginCreateRule. Any rules added here are removed
      * from the digester when the end of that xml tag is encountered.
+     * <p>
+     * Note that this method will normally call the addRule method on some
+     * RuleManager instance, which can potentially throw an InvalidRuleException.
+     * In that case, the implementation of that method will wrap that exception
+     * in a PluginException.
      */
     public abstract void addRules(Context context) throws PluginException;
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org