org.apache.tomcat.util.digester: abstract public class: Rule

org.apache.tomcat.util.digester
abstract public class: Rule [javadoc | source]

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

Direct Known Subclasses:
SetNextNamingRule, CallMethodMultiRule, ObjectParamRule, SetAuthConstraintRule, MemoryUserRule, SetRootRule, CallMethodRule, SetJspConfig, SetContextPropertiesRule, SetPublicIdRule, StoreFactoryRule, FactoryCreateRule, CallParamRule, SetPropertyRule, SetTopRule, WrapperCreateRule, SetAllPropertiesRule, SetSessionConfig, ObjectCreateRule, CallParamMultiRule, NodeCreateRule, ServiceQnameRule, SetNextRule, SoapHeaderRule, SetLoginConfig, IgnoreAnnotationsRule, LifecycleListenerRule, PathCallParamRule, SetDistributableRule, SecurityRoleRefCreateRule, SetParentClassLoaderRule, SetPropertiesRule, ConnectorCreateRule, CopyParentClassLoaderRule

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	digester	The Digester with which this Rule is associated.
protected String	namespaceURI	The namespace URI for which this Rule is relevant, if any.

Constructor:

Constructor:
public Rule() { } Base constructor. Now the digester will be set when the rule is added.
public Rule(Digester digester) { super(); setDigester(digester); } Constructor sets the associated Digester. Parameters: `digester` - The digester with which this rule is associated

 public Rule() {

}

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

 public Rule(Digester digester) {
        super();
        setDigester(digester);
}

Constructor sets the associated Digester.

Parameters:

digester - The digester with which this rule is associated

Method from org.apache.tomcat.util.digester.Rule Summary:
begin, begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.tomcat.util.digester.Rule Detail:
public void begin(Attributes attributes) throws Exception { ; // The default implementation does nothing } 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.
public void begin(String namespace, String name, Attributes attributes) throws Exception { begin(attributes); } 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.
public void body(String text) throws Exception { ; // The default implementation does nothing } 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.
public void body(String namespace, String name, String text) throws Exception { body(text); } 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.
public void end() throws Exception { ; // The default implementation does nothing } 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.
public void end(String namespace, String name) throws Exception { end(); } 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.
public void finish() throws Exception { ; // The default implementation does nothing } This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
public Digester getDigester() { // ------------------------------------------------------------- Properties return (this.digester); } Return the Digester with which this Rule is associated.
public String getNamespaceURI() { return (this.namespaceURI); } Return the namespace URI for which this Rule is relevant, if any.
public void setDigester(Digester digester) { this.digester = digester; } Set the `Digester` with which this `Rule` is associated.
public void setNamespaceURI(String namespaceURI) { this.namespaceURI = namespaceURI; } Set the namespace URI for which this Rule is relevant, if any.

Method from org.apache.tomcat.util.digester.Rule Detail:

 public  void begin(Attributes attributes) throws Exception {
        ;	// The default implementation does nothing
}

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.

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

begin

namespace

name

 public  void body(String text) throws Exception {
        ;	// The default implementation does nothing
}

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.

 public  void body(String namespace,
    String name,
    String text) throws Exception {
        body(text);
}

body

namespace

name

 public  void end() throws Exception {
        ;	// The default implementation does nothing
}

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.

 public  void end(String namespace,
    String name) throws Exception {
        end();
}

end

namespace

name

 public  void finish() throws Exception {
        ;	// The default implementation does nothing
}

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

 public Digester getDigester() {
    // ------------------------------------------------------------- Properties
        return (this.digester);
}

Return the Digester with which this Rule is associated.

 public String getNamespaceURI() {
        return (this.namespaceURI);
}

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

 public  void setDigester(Digester digester) {
        
        this.digester = digester;
}

Digester

Rule

 public  void setNamespaceURI(String namespaceURI) {
        this.namespaceURI = namespaceURI;
}

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