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 Summary
All Methods Instance Methods Abstract 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.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.
-
-
-
Method Detail
-
getDigester
Digester getDigester()
- Returns:
- the Digester instance with which this Rules instance is associated.
-
setDigester
void setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.- Parameters:
digester- The newly associated Digester instance
-
add
void 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 Rulerule- Rule instance to be registered
-
clear
void clear()
Clear all existing Rule instance registrations.
-
match
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. 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, ornullto match regardless of namespace URIpattern- Nesting pattern to be matched- Returns:
- a rules list
-
rules
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. 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
-
-