Package org.apache.tomcat.util.digester
Class Rule
java.lang.Object
org.apache.tomcat.util.digester.Rule
- Direct Known Subclasses:
- AddPortOffsetRule,- CallMethodRule,- CallParamRule,- CertificateCreateRule,- ConnectorCreateRule,- CopyParentClassLoaderRule,- FactoryCreateRule,- LifecycleListenerRule,- ObjectCreateRule,- SetNextNamingRule,- SetNextRule,- SetPropertiesRule,- StoreFactoryRule
Concrete implementations of this class implement actions to be taken when
 a corresponding nested pattern of XML elements has been matched.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected DigesterThe Digester with which this Rule is associated.protected StringThe namespace URI for which this Rule is relevant, if any.protected static final StringManager
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidbegin(String namespace, String name, Attributes attributes) This method is called when the beginning of a matching XML element is encountered.voidThis method is called when the body of a matching XML element is encountered.voidThis method is called when the end of a matching XML element is encountered.voidfinish()This method is called after all parsing methods have been called, to allow Rules to remove temporary data.Identify the Digester with which this Rule is associated.Return the namespace URI for which this Rule is relevant, if any.voidsetDigester(Digester digester) Set theDigesterwith which thisRuleis associated.voidsetNamespaceURI(String namespaceURI) Set the namespace URI for which this Rule is relevant, if any.
- 
Field Details- 
sm
- 
digesterThe Digester with which this Rule is associated.
- 
namespaceURIThe namespace URI for which this Rule is relevant, if any.
 
- 
- 
Constructor Details- 
Rulepublic Rule()Base constructor. Now the digester will be set when the rule is added. 
 
- 
- 
Method Details- 
getDigesterIdentify the Digester with which this Rule is associated.- Returns:
- the Digester with which this Rule is associated.
 
- 
setDigesterSet theDigesterwith which thisRuleis associated.- Parameters:
- digester- The digester with which to associate this rule
 
- 
getNamespaceURIReturn the namespace URI for which this Rule is relevant, if any.- Returns:
- The namespace URI for which this rule is relevant or
         nullif none.
 
- 
setNamespaceURISet the namespace URI for which this Rule is relevant, if any.- Parameters:
- namespaceURI- Namespace URI for which this Rule is relevant, or- nullto match independent of namespace.
 
- 
beginThis method is called when the beginning of a matching XML element is encountered. The default implementation is a NO-OP.- 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- if an error occurs while processing the event
 
- 
bodyThis 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 is a NO-OP.- 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:
- Exception- if an error occurs while processing the event
 
- 
endThis method is called when the end of a matching XML element is encountered. The default implementation is a NO-OP.- 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:
- Exception- if an error occurs while processing the event
 
- 
finishThis method is called after all parsing methods have been called, to allow Rules to remove temporary data.- Throws:
- Exception- if an error occurs while processing the event
 
 
-