Save This Page
Home » commons-digester-1.8-src » org.apache.commons » digester » [javadoc | source]
org.apache.commons.digester
public class: RulesBase [javadoc | source]
java.lang.Object
   org.apache.commons.digester.RulesBase

All Implemented Interfaces:
    Rules

Direct Known Subclasses:
    ExtendedBaseRules

Default implementation of the Rules interface that supports the standard rule matching behavior. This class can also be used as a base class for specialized Rules implementations.

The matching policies implemented by this class support two different types of pattern matching rules:

Note that wildcard patterns are ignored if an explicit match can be found (and when multiple wildcard patterns match, only the longest, ie most explicit, pattern is considered a match).

See the package documentation for package org.apache.commons.digester for more information.

Field Summary
protected  HashMap cache    The set of registered Rule instances, keyed by the matching pattern. Each value is a List containing the Rules for that pattern, in the order that they were orginally registered. 
protected  Digester digester    The Digester instance with which this Rules instance is associated. 
protected  String namespaceURI    The namespace URI for which subsequently added Rule objects are relevant, or null for matching independent of namespaces. 
protected  ArrayList rules    The set of registered Rule instances, in the order that they were originally registered. 
Method from org.apache.commons.digester.RulesBase Summary:
add,   clear,   getDigester,   getNamespaceURI,   lookup,   match,   match,   rules,   setDigester,   setNamespaceURI
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.digester.RulesBase Detail:
 public  void add(String pattern,
    Rule rule) 
    Register a new Rule instance matching the specified pattern.
 public  void clear() 
    Clear all existing Rule instance registrations.
 public Digester getDigester() 
    Return the Digester instance with which this Rules instance is associated.
 public String getNamespaceURI() 
    Return the namespace URI that will be applied to all subsequently added Rule objects.
 protected List lookup(String namespaceURI,
    String pattern) 
    Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any). If there are no such rules, return null.
 public List match(String pattern) 
Deprecated! Call - match(namespaceURI,pattern) instead.

    Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches. If more than one Rule instance matches, they must be returned in the order originally registered through the add() method.
 public List match(String namespaceURI,
    String pattern) 
    Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches. If more than one Rule instance matches, they must be returned in the order originally registered through the add() method.
 public List rules() 
    Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances. If more than one Rule instance has been registered, they must be returned in the order originally registered through the add() method.
 public  void setDigester(Digester digester) 
    Set the Digester instance with which this Rules instance is associated.
 public  void setNamespaceURI(String namespaceURI) 
    Set the namespace URI that will be applied to all subsequently added Rule objects.