Package org.apache.tomcat.util.digester
Class AbstractRulesImpl
- java.lang.Object
-
- org.apache.tomcat.util.digester.AbstractRulesImpl
-
- All Implemented Interfaces:
Rules
public abstract class AbstractRulesImpl extends Object implements Rules
AbstractRuleImpl
provides basic services forRules
implementations. Extending this class should make it easier to create aRules
implementation.AbstractRuleImpl
manages theDigester
andnamespaceUri
properties. If the subclass overridesregisterRule(java.lang.String, org.apache.tomcat.util.digester.Rule)
(rather thanadd(java.lang.String, org.apache.tomcat.util.digester.Rule)
), then theDigester
andnamespaceURI
of theRule
will be set correctly before it is passed toregisterRule
. The subclass can then perform whatever it needs to do to register the rule.- Since:
- 1.5
-
-
Constructor Summary
Constructors Constructor Description AbstractRulesImpl()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
add(String pattern, Rule rule)
Registers a new Rule instance matching the specified pattern.abstract void
clear()
Clear all existing Rule instance registrations.Digester
getDigester()
Return the Digester instance with which this Rules instance is associated.String
getNamespaceURI()
Return the namespace URI that will be applied to all subsequently addedRule
objects.abstract List<Rule>
match(String namespaceURI, 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.protected abstract void
registerRule(String pattern, Rule rule)
Register rule at given pattern.abstract List<Rule>
rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.void
setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.void
setNamespaceURI(String namespaceURI)
Set the namespace URI that will be applied to all subsequently addedRule
objects.
-
-
-
Method Detail
-
getDigester
public Digester getDigester()
Return the Digester instance with which this Rules instance is associated.- Specified by:
getDigester
in interfaceRules
-
setDigester
public void setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.- Specified by:
setDigester
in interfaceRules
- Parameters:
digester
- The newly associated Digester instance
-
getNamespaceURI
public String getNamespaceURI()
Return the namespace URI that will be applied to all subsequently addedRule
objects.- Specified by:
getNamespaceURI
in interfaceRules
-
setNamespaceURI
public void setNamespaceURI(String namespaceURI)
Set the namespace URI that will be applied to all subsequently addedRule
objects.- Specified by:
setNamespaceURI
in interfaceRules
- Parameters:
namespaceURI
- Namespace URI that must match on all subsequently added rules, ornull
for matching regardless of the current namespace URI
-
add
public void add(String pattern, Rule rule)
Registers a new Rule instance matching the specified pattern. This implementation sets theDigester
and thenamespaceURI
on theRule
before callingregisterRule(java.lang.String, org.apache.tomcat.util.digester.Rule)
.
-
registerRule
protected abstract void registerRule(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.- Parameters:
pattern
- Nesting pattern to be matched for this Rulerule
- Rule instance to be registered
-
clear
public abstract void clear()
Clear all existing Rule instance registrations.
-
match
public abstract List<Rule> match(String namespaceURI, 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.
-
-