Package org.apache.tomcat.util.digester
Interface Rules
- 
- All Known Implementing Classes:
- RulesBase
 
 public interface RulesPublic 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.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidadd(java.lang.String pattern, Rule rule)Register a new Rule instance matching the specified pattern.voidclear()Clear all existing Rule instance registrations.DigestergetDigester()java.lang.StringgetNamespaceURI()Deprecated.Unused.java.util.List<Rule>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.java.util.List<Rule>rules()Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.voidsetDigester(Digester digester)Set the Digester instance with which this Rules instance is associated.voidsetNamespaceURI(java.lang.String namespaceURI)Deprecated.Unused.
 
- 
- 
- 
Method Detail- 
getDigesterDigester getDigester() - Returns:
- the Digester instance with which this Rules instance is associated.
 
 - 
setDigestervoid setDigester(Digester digester) Set the Digester instance with which this Rules instance is associated.- Parameters:
- digester- The newly associated Digester instance
 
 - 
getNamespaceURI@Deprecated java.lang.String getNamespaceURI() Deprecated.Unused. Will be removed in Tomcat 9- Returns:
- the namespace URI that will be applied to all subsequently
 added Ruleobjects.
 
 - 
setNamespaceURI@Deprecated void setNamespaceURI(java.lang.String namespaceURI) Deprecated.Unused. Will be removed in Tomcat 9Set the namespace URI that will be applied to all subsequently addedRuleobjects.- Parameters:
- namespaceURI- Namespace URI that must match on all subsequently added rules, or- nullfor matching regardless of the current namespace URI
 
 - 
addvoid add(java.lang.String pattern, Rule rule)Register a new Rule instance matching the specified pattern.- Parameters:
- pattern- Nesting pattern to be matched for this Rule
- rule- Rule instance to be registered
 
 - 
clearvoid clear() Clear all existing Rule instance registrations.
 - 
matchjava.util.List<Rule> 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 theadd()method.- Parameters:
- namespaceURI- Namespace URI for which to select matching rules, or- nullto match regardless of namespace URI
- pattern- Nesting pattern to be matched
- Returns:
- a rules list
 
 - 
rulesjava.util.List<Rule> 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 theadd()method.- Returns:
- a rules list
 
 
- 
 
-