org.apache.tomcat.util.digester
public abstract class AbstractRulesImpl extends Object implements Rules
AbstractRuleImpl
provides basic services for Rules
implementations.
Extending this class should make it easier to create a Rules
implementation.
AbstractRuleImpl
manages the Digester
and namespaceUri
properties.
If the subclass overrides AbstractRulesImpl (rather than AbstractRulesImpl),
then the Digester
and namespaceURI
of the Rule
will be set correctly before it is passed to registerRule
.
The subclass can then perform whatever it needs to do to register the rule.
Since: 1.5
Method Summary | |
---|---|
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
added Rule objects. |
List | match(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. |
abstract List | 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 | 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
added Rule objects.
|
Digester
and the
namespaceURI
on the Rule
before calling AbstractRulesImpl.
Parameters: pattern Nesting pattern to be matched for this Rule rule Rule instance to be registered
Rule
objects.Deprecated: Call match(namespaceURI,pattern) instead.
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: pattern Nesting pattern to be matched
add()
method.
Parameters: namespaceURI Namespace URI for which to select matching rules,
or null
to match regardless of namespace URI pattern Nesting pattern to be matched
Rule
can be assumed to have been set properly before this method is called.
Parameters: pattern Nesting pattern to be matched for this Rule rule Rule instance to be registered
add()
method.Parameters: digester The newly associated Digester instance
Rule
objects.
Parameters: namespaceURI Namespace URI that must match on all
subsequently added rules, or null
for matching
regardless of the current namespace URI