Field Detail

• digester

  protected Digester digester

  The Digester with which this Rule is associated.

• namespaceURI

  protected java.lang.String namespaceURI

  The namespace URI for which this Rule is relevant, if any.

Constructor Detail

• Rule

  public Rule()

  Base constructor. Now the digester will be set when the rule is added.

Method Detail

• getDigester

  public Digester getDigester()

  Return the Digester with which this Rule is associated.

• setDigester

  public void setDigester(Digester digester)

  Set the Digester with which this Rule is associated.

• getNamespaceURI

  public java.lang.String getNamespaceURI()

  Return the namespace URI for which this Rule is relevant, if any.

• setNamespaceURI

  public void setNamespaceURI(java.lang.String namespaceURI)

  Set the namespace URI for which this Rule is relevant, if any.

  Parameters:

  namespaceURI - Namespace URI for which this Rule is relevant, or null to match independent of namespace.

• begin

  @Deprecated
  public void begin(org.xml.sax.Attributes attributes)
             throws java.lang.Exception

  Deprecated. Use the begin method with namespace and name parameters instead.
  This method is called when the beginning of a matching XML element is encountered.

  Parameters:

  attributes - The attribute list of this element

  Throws:

  java.lang.Exception

• begin

  public void begin(java.lang.String namespace,
           java.lang.String name,
           org.xml.sax.Attributes attributes)
             throws java.lang.Exception

  This method is called when the beginning of a matching XML element is encountered. The default implementation delegates to the deprecated method begin without the namespace and name parameters, to retain backwards compatibility.

  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:

  java.lang.Exception

  Since:

  Digester 1.4

• body

  @Deprecated
  public void body(java.lang.String text)
            throws java.lang.Exception

  Deprecated. Use the body method with namespace and name parameters instead.
  This method is called when the body of a matching XML element is encountered. If the element has no body, this method is not called at all.

  Parameters:

  text - The text of the body of this element

  Throws:

  java.lang.Exception

• body

  public void body(java.lang.String namespace,
          java.lang.String name,
          java.lang.String text)
            throws java.lang.Exception

  This method is called when the body of a matching XML element is encountered. If the element has no body, this method is not called at all. The default implementation delegates to the deprecated method body without the namespace and name parameters, to retain backwards compatibility.

  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

  text - The text of the body of this element

  Throws:

  java.lang.Exception

  Since:

  Digester 1.4

• end

  @Deprecated
  public void end()
           throws java.lang.Exception

  Deprecated. Use the end method with namespace and name parameters instead.
  This method is called when the end of a matching XML element is encountered.

  Throws:

  java.lang.Exception

• end

  public void end(java.lang.String namespace,
         java.lang.String name)
           throws java.lang.Exception

  This method is called when the end of a matching XML element is encountered. The default implementation delegates to the deprecated method end without the namespace and name parameters, to retain backwards compatibility.

  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

  Throws:

  java.lang.Exception

  Since:

  Digester 1.4

• finish

  public void finish()
              throws java.lang.Exception

  This method is called after all parsing methods have been called, to allow Rules to remove temporary data.

  Throws:

  java.lang.Exception