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 Summary
Modifier and TypeMethodDescriptionvoidRegister a new Rule instance matching the specified pattern.voidclear()Clear all existing Rule instance registrations.Deprecated.Unused.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.voidsetNamespaceURI(String namespaceURI) Deprecated.Unused.
-
Method Details
-
getDigester
Digester getDigester()- Returns:
- the Digester instance with which this Rules instance is associated.
-
setDigester
Set the Digester instance with which this Rules instance is associated.- Parameters:
digester- The newly associated Digester instance
-
getNamespaceURI
Deprecated.Unused. Will be removed in Tomcat 9- Returns:
- the namespace URI that will be applied to all subsequently
added
Ruleobjects.
-
setNamespaceURI
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, ornullfor matching regardless of the current namespace URI
-
add
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
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
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
-