commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1129505 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
Date Tue, 31 May 2011 05:52:26 GMT
Author: simonetripodi
Date: Tue May 31 05:52:26 2011
New Revision: 1129505

URL: http://svn.apache.org/viewvc?rev=1129505&view=rev
Log:
fixed javadocs violations

Modified:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java?rev=1129505&r1=1129504&r2=1129505&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
(original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromResource.java
Tue May 31 05:52:26 2011
@@ -38,7 +38,8 @@ public class FinderFromResource
 {
 
     /**
-     * Name of xml attribute on the plugin declaration which is used to configure rule-loading
for that declaration.
+     * Default name of xml attribute on the plugin declaration which is used to configure
rule-loading
+     * for that declaration.
      */
     public static String DFLT_RESOURCE_ATTR = "resource";
 
@@ -51,7 +52,12 @@ public class FinderFromResource
         this( DFLT_RESOURCE_ATTR );
     }
 
-    /** See {@link #findLoader}. */
+    /**
+     * See {@link #findLoader}.
+     *
+     * @param resourceAttr Name of xml attribute on the plugin declaration which is used
to configure rule-loading
+     *        for that declaration
+     */
     public FinderFromResource( String resourceAttr )
     {
         this.resourceAttr = resourceAttr;
@@ -65,6 +71,13 @@ public class FinderFromResource
      * <p>
      * The returned object (when non-null) will add the selected rules to the digester whenever
its addRules method is
      * invoked.
+     *
+     * @param d The digester instance where locating plugin classes
+     * @param pluginClass The plugin Java class
+     * @param p The properties object that holds any xml attributes the user may have specified
on the plugin
+     *          declaration in order to indicate how to locate the plugin rules.
+     * @throws PluginException if the algorithm finds a source of rules, but there is something
invalid
+     *         about that source.
      */
     @Override
     public RuleLoader findLoader( Digester d, Class<?> pluginClass, Properties p )
@@ -96,6 +109,7 @@ public class FinderFromResource
      * @param pluginClass is the class whose xml params the rules are parsing.
      * @param is is where the xmlrules will be read from, and must be non-null.
      * @param resourceName is a string describing the source of the xmlrules, for use in
generating error messages.
+     * @throws PluginException if any error occurs
      */
     public static RuleLoader loadRules( Digester d, Class<?> pluginClass, InputStream
is, String resourceName )
         throws PluginException



Mime
View raw message