Class FinderFromMethod

java.lang.Object
org.apache.commons.digester3.plugins.RuleFinder
org.apache.commons.digester3.plugins.strategies.FinderFromMethod

public class FinderFromMethod extends RuleFinder
A rule-finding algorithm which expects the caller to specify a methodname as a plugin property, where the method exists on the plugin class.
Since:
1.6
  • Field Details

  • Constructor Details

  • Method Details

    • findLoader

      public RuleLoader findLoader(Digester d, Class<?> pluginClass, Properties p) throws PluginException
      If there exists a property with the name matching constructor param methodAttr, then locate the appropriate Method on the plugin class and return an object encapsulating that info.

      If there is no matching property provided, then just return null.

      The returned object (when non-null) will invoke the target method on the plugin class whenever its addRules method is invoked. The target method is expected to have the following prototype: public static void xxxxx(Digester d, String patternPrefix);

      Specified by:
      findLoader in class RuleFinder
      Parameters:
      d - The digester instance where locating plugin classes
      pluginClass - The plugin Java class
      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.
      Returns:
      a source of digester rules for the specified plugin class.
      Throws:
      PluginException - if the algorithm finds a source of rules, but there is something invalid about that source.