You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by si...@apache.org on 2011/05/30 22:59:43 UTC
svn commit: r1129365 -
/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
Author: simonetripodi
Date: Mon May 30 20:59:43 2011
New Revision: 1129365
URL: http://svn.apache.org/viewvc?rev=1129365&view=rev
Log:
added missing javadoc
Modified:
commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java?rev=1129365&r1=1129364&r2=1129365&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java (original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/PluginManager.java Mon May 30 20:59:43 2011
@@ -55,7 +55,11 @@ public class PluginManager
// ------------------- constructors ---------------------------------------
- /** Construct a "root" PluginManager, ie one with no parent. */
+ /**
+ * Construct a "root" PluginManager, ie one with no parent.
+ *
+ * @param r The object containing data that should only exist once for each Digester instance.
+ */
public PluginManager( PluginContext r )
{
pluginContext = r;
@@ -108,6 +112,8 @@ public class PluginManager
/**
* Return the declaration object with the specified class. If no such plugin is known, null is returned.
+ *
+ * @param className The {@link Declaration} class name
*/
public Declaration getDeclarationByClass( String className )
{
@@ -144,6 +150,14 @@ public class PluginManager
* detects a source of custom rules for this plugin (aka a RuleLoader).
* <p>
* If no source of custom rules can be found, null is returned.
+ *
+ * @param digester The digeste rinstance where locating plugin classes
+ * @param id The id that the user associated with a particular plugin declaration in the input xml
+ * @param pluginClass The plugin Java class
+ * @param props 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.
+ * @return The discovered Rule loader instance
+ * @throws PluginException if any error occurs while finding the loader
*/
public RuleLoader findLoader( Digester digester, String id, Class<?> pluginClass, Properties props )
throws PluginException