File Doc Category Size Date Package
Rules.java API Doc Apache Tomcat 6.0.14 4232 Fri Jul 20 04:20:36 BST 2007 org.apache.tomcat.util.digester

Rules

public interface Rules

Public interface defining a collection of Rule instances (and corresponding matching patterns) plus an implementation of a matching policy that selects the rules that match a particular pattern of nested elements discovered during parsing.

Fields Summary
Constructors Summary
Methods Summary
public void add(java.lang.String pattern, Rule rule)
Register a new Rule instance matching the specified pattern.
param
pattern Nesting pattern to be matched for this Rule
param
rule Rule instance to be registered
public void clear()
Clear all existing Rule instance registrations.
public Digester getDigester()
Return the Digester instance with which this Rules instance is associated.
public java.lang.String getNamespaceURI()
Return the namespace URI that will be applied to all subsequently added Rule objects.
public java.util.List match(java.lang.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.
param
pattern Nesting pattern to be matched
deprecated
Call match(namespaceURI,pattern) instead.
public java.util.List match(java.lang.String namespaceURI, java.lang.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.
param
namespaceURI Namespace URI for which to select matching rules, or null to match regardless of namespace URI
param
pattern Nesting pattern to be matched
public java.util.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.
param
digester The newly associated Digester instance
public void setNamespaceURI(java.lang.String namespaceURI)
Set the namespace URI that will be applied to all subsequently added Rule objects.
param
namespaceURI Namespace URI that must match on all subsequently added rules, or null for matching regardless of the current namespace URI