Package org.apache.commons.digester3
Class RegexRules
- java.lang.Object
-
- org.apache.commons.digester3.AbstractRulesImpl
-
- org.apache.commons.digester3.RegexRules
-
- All Implemented Interfaces:
Rules
public class RegexRules extends AbstractRulesImpl
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 Classes Modifier and Type Class Description private static class
RegexRules.RegisteredRule
Used to associate rules with paths in the rules list
-
Field Summary
Fields Modifier and Type Field Description private RegexMatcher
matcher
The regex strategy used by this RegexRulesprivate java.util.ArrayList<RegexRules.RegisteredRule>
registeredRules
All registeredRule
's
-
Constructor Summary
Constructors Constructor Description RegexRules(RegexMatcher matcher)
Construct sets the Regex matching strategy.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Clear all existing Rule instance registrations.RegexMatcher
getRegexMatcher()
Gets the current regex matching strategy.java.util.List<Rule>
match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.Attributes attributes)
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.protected void
registerRule(java.lang.String pattern, Rule rule)
Register rule at given pattern.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.void
setRegexMatcher(RegexMatcher matcher)
Sets the current regex matching strategy.-
Methods inherited from class org.apache.commons.digester3.AbstractRulesImpl
add, getDigester, getNamespaceURI, setDigester, setNamespaceURI
-
-
-
-
Field Detail
-
registeredRules
private java.util.ArrayList<RegexRules.RegisteredRule> registeredRules
All registeredRule
's
-
matcher
private RegexMatcher matcher
The regex strategy used by this RegexRules
-
-
Constructor Detail
-
RegexRules
public RegexRules(RegexMatcher matcher)
Construct sets the Regex matching strategy.- Parameters:
matcher
- the regex strategy to be used, not null
-
-
Method Detail
-
getRegexMatcher
public RegexMatcher getRegexMatcher()
Gets the current regex matching strategy.- Returns:
- the current regex matching strategy.
-
setRegexMatcher
public void setRegexMatcher(RegexMatcher matcher)
Sets the current regex matching strategy.- Parameters:
matcher
- use this RegexMatcher, not null
-
registerRule
protected void registerRule(java.lang.String pattern, Rule rule)
Register rule at given pattern. The the Digester and namespaceURI properties of the givenRule
can be assumed to have been set properly before this method is called.- 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.
-
match
public java.util.List<Rule> match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.Attributes attributes)
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, ornull
to match regardless of namespace URIpattern
- Nesting pattern to be matchedname
- the local name if the parser is namespace aware, or just the element name otherwiseattributes
- The attribute list of the current matching element- Returns:
- a List of all registered Rule instances that match the specified nesting pattern
-
rules
public 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 List of all registered Rule instances
-
-