Class ConfigRegisterRule

java.lang.Object
org.apache.commons.digester.Rule
org.apache.commons.chain.config.ConfigRegisterRule
class ConfigRegisterRule extends org.apache.commons.digester.Rule

Digester rule that will cause the top-most element on the Digester stack (if it is a Command to be registered with the next-to-top element on the Digester stack (if it is a Catalog or Chain). To be registered with a Catalog, the top-most element must contain a value for the specified attribute that contains the name under which it should be registered.

Version:
$Revision: 480477 $ $Date: 2006-11-29 08:34:52 +0000 (Wed, 29 Nov 2006) $
Author:
Craig R. McClanahan

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    nameAttribute
    The name of the attribute under which we can retrieve the name this command should be registered with.

    Fields inherited from class org.apache.commons.digester.Rule

    digester, namespaceURI

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigRegisterRule(String nameAttribute)
    Construct a new instance of this rule that looks for an attribute with the specified name.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    begin(String namespace, String name, Attributes attributes)
    Register the top Command if appropriate.

    Methods inherited from class org.apache.commons.digester.Rule

    begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • nameAttribute

      private String nameAttribute

      The name of the attribute under which we can retrieve the name this command should be registered with.

  • Constructor Details

    • ConfigRegisterRule

      public ConfigRegisterRule(String nameAttribute)

      Construct a new instance of this rule that looks for an attribute with the specified name.

      Parameters:
      nameAttribute - Name of the attribute containing the name under which this command should be registered

  • Method Details

    • begin

      public void begin(String namespace, String name, Attributes attributes) throws Exception

      Register the top Command if appropriate.

      Overrides:
      begin in class org.apache.commons.digester.Rule
      Parameters:
      namespace - the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
      name - the local name if the parser is namespace aware, or just the element name otherwise
      attributes - The attribute list of this element
      Throws:
      Exception