Rule (Apache Tomcat 7.0.109 API Documentation)

java.lang.Object
- org.apache.tomcat.util.digester.Rule

Direct Known Subclasses:

CallMethodRule, CallParamRule, ConnectorCreateRule, CopyParentClassLoaderRule, FactoryCreateRule, LifecycleListenerRule, NodeCreateRule, ObjectCreateRule, ObjectParamRule, PathCallParamRule, SetAllPropertiesRule, SetContextPropertiesRule, SetNextNamingRule, SetNextRule, SetPropertiesRule, SetPropertyRule, SetRootRule, SetTopRule
```
public abstract class Rule
extends Object
```
Concrete implementations of this class implement actions to be taken when a corresponding nested pattern of XML elements has been matched.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Digester`	`digester` The Digester with which this Rule is associated.
`protected String`	`namespaceURI` The namespace URI for which this Rule is relevant, if any.

Constructor Summary

Constructors
Constructor and Description

Rule()
Base constructor.

Constructors
Constructor and Description
`Rule()` Base constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`begin(Attributes attributes)` Deprecated. Use the `begin` method with `namespace` and `name` parameters instead.
`void`	`begin(String namespace, String name, Attributes attributes)` This method is called when the beginning of a matching XML element is encountered.
`void`	`body(String text)` Deprecated. Use the `body` method with `namespace` and `name` parameters instead.
`void`	`body(String namespace, String name, String text)` This method is called when the body of a matching XML element is encountered.
`void`	`end()` Deprecated. Use the `end` method with `namespace` and `name` parameters instead.
`void`	`end(String namespace, 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.
`String`	`getNamespaceURI()` Return the namespace URI for which this Rule is relevant, if any.
`void`	`setDigester(Digester digester)` Set the `Digester` with which this `Rule` is associated.
`void`	`setNamespaceURI(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
  - digester
```
protected Digester digester
```
    The Digester with which this Rule is associated.
  - namespaceURI
```
protected 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 String getNamespaceURI()
```
    Return the namespace URI for which this Rule is relevant, if any.
  - setNamespaceURI
```
public void setNamespaceURI(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(Attributes attributes)
           throws 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:
    
    Exception
  - begin
```
public void begin(String namespace,
         String name,
         Attributes attributes)
           throws 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:
    
    Exception
    Since:
    
    Digester 1.4
  - body
```
@Deprecated
public void body(String text)
          throws 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:
    
    Exception
  - body
```
public void body(String namespace,
        String name,
        String text)
          throws 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:
    
    Exception
    Since:
    
    Digester 1.4
  - end
```
@Deprecated
public void end()
         throws 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:
    
    Exception
  - end
```
public void end(String namespace,
       String name)
         throws 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:
    
    Exception
    Since:
    
    Digester 1.4
  - finish
```
public void finish()
            throws Exception
```
    This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
    
    Throws:
    
    Exception

Class Rule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

digester

namespaceURI

Constructor Detail

Rule

Method Detail

getDigester

setDigester

getNamespaceURI

setNamespaceURI

begin

begin

body

body

end

end

finish