|
Apache Tomcat 6.0.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tomcat.util.digester.AbstractRulesImpl
public abstract class AbstractRulesImpl
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 registerRule(java.lang.String, org.apache.tomcat.util.digester.Rule) (rather than add(java.lang.String, org.apache.tomcat.util.digester.Rule)),
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.
| Constructor Summary | |
|---|---|
AbstractRulesImpl()
|
|
| Method Summary | |
|---|---|
void |
add(java.lang.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. |
java.lang.String |
getNamespaceURI()
Return the namespace URI that will be applied to all subsequently added Rule objects. |
java.util.List |
match(java.lang.String pattern)
Deprecated. Call match(namespaceURI,pattern) instead. |
abstract java.util.List |
match(java.lang.String namespaceURI,
java.lang.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(java.lang.String pattern,
Rule rule)
Register rule at given pattern. |
abstract java.util.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(java.lang.String namespaceURI)
Set the namespace URI that will be applied to all subsequently added Rule objects. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractRulesImpl()
| Method Detail |
|---|
public Digester getDigester()
getDigester in interface Rulespublic void setDigester(Digester digester)
setDigester in interface Rulesdigester - The newly associated Digester instancepublic java.lang.String getNamespaceURI()
Rule objects.
getNamespaceURI in interface Rulespublic void setNamespaceURI(java.lang.String namespaceURI)
Rule objects.
setNamespaceURI in interface RulesnamespaceURI - Namespace URI that must match on all
subsequently added rules, or null for matching
regardless of the current namespace URI
public void add(java.lang.String pattern,
Rule rule)
Digester and the
namespaceURI on the Rule before calling registerRule(java.lang.String, org.apache.tomcat.util.digester.Rule).
add in interface Rulespattern - Nesting pattern to be matched for this Rulerule - Rule instance to be registered
protected abstract void registerRule(java.lang.String pattern,
Rule rule)
Rule
can be assumed to have been set properly before this method is called.
pattern - Nesting pattern to be matched for this Rulerule - Rule instance to be registeredpublic abstract void clear()
clear in interface Rulespublic java.util.List match(java.lang.String pattern)
add()
method.
match in interface Rulespattern - Nesting pattern to be matched
public abstract java.util.List match(java.lang.String namespaceURI,
java.lang.String pattern)
add()
method.
match in interface RulesnamespaceURI - Namespace URI for which to select matching rules,
or null to match regardless of namespace URIpattern - Nesting pattern to be matchedpublic abstract java.util.List rules()
add()
method.
rules in interface Rules
|
Apache Tomcat 6.0.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||