Package org.apache.tomcat.util.digester
Interface Rules
- All Known Implementing Classes:
- RulesBase
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.
- 
Method SummaryModifier and TypeMethodDescriptionvoidRegister a new Rule instance matching the specified pattern.voidclear()Clear all existing Rule instance registrations.Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.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.
- 
Method Details- 
getDigesterDigester getDigester()- Returns:
- the Digester instance with which this Rules instance is associated.
 
- 
setDigesterSet the Digester instance with which this Rules instance is associated.- Parameters:
- digester- The newly associated Digester instance
 
- 
addRegister 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.
- 
matchReturn 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
 
- 
rulesReturn 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
 
 
-