Package org.apache.commons.digester
Class RegexRules
java.lang.Object
org.apache.commons.digester.AbstractRulesImpl
org.apache.commons.digester.RegexRules
- All Implemented Interfaces:
Rules
Rules implementation that uses regular expression matching for paths.
The regex implementation is pluggable, allowing different strategies to be used. The basic way that this class work does not vary. All patterns are tested to see if they match the path using the regex matcher. All those that do are return in the order which the rules were added.
- Since:
- 1.5
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
Used to associate rules with paths in the rules list -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate RegexMatcher
The regex strategy used by this RegexRulesprivate ArrayList
<RegexRules.RegisteredRule> All registeredRule
's -
Constructor Summary
ConstructorsConstructorDescriptionRegexRules
(RegexMatcher matcher) Construct sets the Regex matching strategy. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear all existing Rule instance registrations.Gets the current regex matching strategy.Finds matching rules by using current regex matching strategy.protected void
registerRule
(String pattern, Rule rule) Register a new Rule instance matching the specified pattern.rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.void
setRegexMatcher
(RegexMatcher matcher) Sets the current regex matching strategy.Methods inherited from class org.apache.commons.digester.AbstractRulesImpl
add, getDigester, getNamespaceURI, match, setDigester, setNamespaceURI
-
Field Details
-
registeredRules
All registeredRule
's -
matcher
The regex strategy used by this RegexRules
-
-
Constructor Details
-
RegexRules
Construct sets the Regex matching strategy.- Parameters:
matcher
- the regex strategy to be used, not null- Throws:
IllegalArgumentException
- if the strategy is null
-
-
Method Details
-
getRegexMatcher
Gets the current regex matching strategy. -
setRegexMatcher
Sets the current regex matching strategy.- Parameters:
matcher
- use this RegexMatcher, not null- Throws:
IllegalArgumentException
- if the strategy is null
-
registerRule
Register a new Rule instance matching the specified pattern.- Specified by:
registerRule
in classAbstractRulesImpl
- Parameters:
pattern
- Nesting pattern to be matched for this Rulerule
- Rule instance to be registered
-
clear
public void clear()Clear all existing Rule instance registrations.- Specified by:
clear
in interfaceRules
- Specified by:
clear
in classAbstractRulesImpl
-
match
Finds matching rules by using current regex matching strategy. The rule associated with each path that matches is added to the list of matches. The order of matching rules is the same order that they were added.- Specified by:
match
in interfaceRules
- Specified by:
match
in classAbstractRulesImpl
- Parameters:
namespaceURI
- Namespace URI for which to select matching rules, ornull
to match regardless of namespace URIpattern
- Nesting pattern to be matched- Returns:
- a list of matching
Rule
's
-
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.- Specified by:
rules
in interfaceRules
- Specified by:
rules
in classAbstractRulesImpl
-