| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tomcat.util.digester.Rule
public abstract class Rule
Concrete implementations of this class implement actions to be taken when a corresponding nested pattern of XML elements has been matched.
| Field Summary | |
|---|---|
| protected  Digester | digesterThe Digester with which this Rule is associated. | 
| protected  java.lang.String | namespaceURIThe namespace URI for which this Rule is relevant, if any. | 
| Constructor Summary | |
|---|---|
| Rule()Base constructor. | |
| Rule(Digester digester)Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule)method. UseRule()instead. | |
| Method Summary | |
|---|---|
|  void | begin(org.xml.sax.Attributes attributes)Deprecated. Use the beginmethod withnamespaceandnameparameters instead. | 
|  void | begin(java.lang.String namespace,
      java.lang.String name,
      org.xml.sax.Attributes attributes)This method is called when the beginning of a matching XML element is encountered. | 
|  void | body(java.lang.String text)Deprecated. Use the bodymethod
   withnamespaceandnameparameters
   instead. | 
|  void | body(java.lang.String namespace,
     java.lang.String name,
     java.lang.String text)This method is called when the body of a matching XML element is encountered. | 
|  void | end()Deprecated. Use the endmethod withnamespaceandnameparameters instead. | 
|  void | end(java.lang.String namespace,
    java.lang.String name)This method is called when the end of a matching XML element is encountered. | 
|  void | finish()This method is called after all parsing methods have been called, to allow Rules to remove temporary data. | 
|  Digester | getDigester()Return the Digester with which this Rule is associated. | 
|  java.lang.String | getNamespaceURI()Return the namespace URI for which this Rule is relevant, if any. | 
|  void | setDigester(Digester digester)Set the Digesterwith which thisRuleis associated. | 
|  void | setNamespaceURI(java.lang.String namespaceURI)Set the namespace URI for which this Rule is relevant, if any. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
protected Digester digester
protected java.lang.String namespaceURI
| Constructor Detail | 
|---|
public Rule(Digester digester)
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule) method. Use Rule() instead.
digester - The digester with which this rule is associatedpublic Rule()
Base constructor. Now the digester will be set when the rule is added.
| Method Detail | 
|---|
public Digester getDigester()
public void setDigester(Digester digester)
Digester with which this Rule is associated.
public java.lang.String getNamespaceURI()
public void setNamespaceURI(java.lang.String namespaceURI)
namespaceURI - Namespace URI for which this Rule is relevant,
  or null to match independent of namespace.
public void begin(org.xml.sax.Attributes attributes)
           throws java.lang.Exception
begin
   method with namespace and name
   parameters instead.
attributes - The attribute list of this element
java.lang.Exception
public void begin(java.lang.String namespace,
                  java.lang.String name,
                  org.xml.sax.Attributes attributes)
           throws java.lang.Exception
begin without the 
 namespace and name parameters, to retain 
 backwards compatibility.
namespace - the namespace URI of the matching element, or an 
   empty string if the parser is not namespace aware or the element has
   no namespacename - the local name if the parser is namespace aware, or just 
   the element name otherwiseattributes - The attribute list of this element
java.lang.Exception
public void body(java.lang.String text)
          throws java.lang.Exception
body method
   with namespace and name parameters
   instead.
text - The text of the body of this element
java.lang.Exception
public void body(java.lang.String namespace,
                 java.lang.String name,
                 java.lang.String text)
          throws java.lang.Exception
body without the namespace and
 name parameters, to retain backwards compatibility.
namespace - the namespace URI of the matching element, or an 
   empty string if the parser is not namespace aware or the element has
   no namespacename - the local name if the parser is namespace aware, or just 
   the element name otherwisetext - The text of the body of this element
java.lang.Exception
public void end()
         throws java.lang.Exception
end method with 
   namespace and name parameters instead.
java.lang.Exception
public void end(java.lang.String namespace,
                java.lang.String name)
         throws java.lang.Exception
end without the 
 namespace and name parameters, to retain 
 backwards compatibility.
namespace - the namespace URI of the matching element, or an 
   empty string if the parser is not namespace aware or the element has
   no namespacename - the local name if the parser is namespace aware, or just 
   the element name otherwise
java.lang.Exception
public void finish()
            throws java.lang.Exception
java.lang.Exception| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||