Class PluginDeclarationRule

java.lang.Object
org.apache.commons.digester.Rule
org.apache.commons.digester.plugins.PluginDeclarationRule

public class PluginDeclarationRule extends Rule
A Digester rule which allows the user to pre-declare a class which is to be referenced later at a plugin point by a PluginCreateRule.

Normally, a PluginDeclarationRule is added to a Digester instance with the pattern "{root}/plugin" or "* /plugin" where {root} is the name of the root tag in the input document.

Since:
1.6
  • Constructor Details

  • Method Details

    • begin

      public void begin(String namespace, String name, Attributes attributes) throws Exception
      Invoked upon reading a tag defining a plugin declaration. The tag must have the following mandatory attributes:
      • id
      • class
      Overrides:
      begin in class Rule
      Parameters:
      namespace - The xml namespace in which the xml element which triggered this rule resides.
      name - The name of the xml element which triggered this rule.
      attributes - The set of attributes on the xml element which triggered this rule.
      Throws:
      Exception
    • declarePlugin

      public static void declarePlugin(Digester digester, Properties props) throws PluginException
      Throws:
      PluginException