|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.digester.RulesBase
public class RulesBase
Default implementation of the Rules
interface that supports
the standard rule matching behavior. This class can also be used as a
base class for specialized Rules
implementations.
The matching policies implemented by this class support two different types of pattern matching rules:
<c>
element, nested inside a <b>
element, which is nested inside an <a>
element.<b>
element, nested inside an <a>
element, no matter how deeply the pair is nested.Note that wildcard patterns are ignored if an explicit match can be found (and when multiple wildcard patterns match, only the longest, ie most explicit, pattern is considered a match).
See the package documentation for package org.apache.commons.digester for more information.
Field Summary | |
---|---|
protected java.util.HashMap |
cache
The set of registered Rule instances, keyed by the matching pattern. |
protected Digester |
digester
The Digester instance with which this Rules instance is associated. |
protected java.lang.String |
namespaceURI
The namespace URI for which subsequently added Rule
objects are relevant, or null for matching independent
of namespaces. |
protected java.util.ArrayList |
rules
The set of registered Rule instances, in the order that they were originally registered. |
Constructor Summary | |
---|---|
RulesBase()
|
Method Summary | |
---|---|
void |
add(java.lang.String pattern,
Rule rule)
Register a new Rule instance matching the specified pattern. |
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. |
protected java.util.List |
lookup(java.lang.String namespaceURI,
java.lang.String pattern)
Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any). |
java.util.List |
match(java.lang.String pattern)
Deprecated. Call match(namespaceURI,pattern) instead. |
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. |
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 |
Field Detail |
---|
protected java.util.HashMap cache
protected Digester digester
protected java.lang.String namespaceURI
Rule
objects are relevant, or null
for matching independent
of namespaces.
protected java.util.ArrayList rules
Constructor Detail |
---|
public RulesBase()
Method Detail |
---|
public Digester getDigester()
getDigester
in interface Rules
public void setDigester(Digester digester)
setDigester
in interface Rules
digester
- The newly associated Digester instancepublic java.lang.String getNamespaceURI()
Rule
objects.
getNamespaceURI
in interface Rules
public void setNamespaceURI(java.lang.String namespaceURI)
Rule
objects.
setNamespaceURI
in interface Rules
namespaceURI
- Namespace URI that must match on all
subsequently added rules, or null
for matching
regardless of the current namespace URIpublic void add(java.lang.String pattern, Rule rule)
add
in interface Rules
pattern
- Nesting pattern to be matched for this Rulerule
- Rule instance to be registeredpublic void clear()
clear
in interface Rules
public java.util.List match(java.lang.String pattern)
add()
method.
match
in interface Rules
pattern
- Nesting pattern to be matchedpublic java.util.List match(java.lang.String namespaceURI, java.lang.String pattern)
add()
method.
match
in interface Rules
namespaceURI
- Namespace URI for which to select matching rules,
or null
to match regardless of namespace URIpattern
- Nesting pattern to be matchedpublic java.util.List rules()
add()
method.
rules
in interface Rules
protected java.util.List lookup(java.lang.String namespaceURI, java.lang.String pattern)
null
.
namespaceURI
- Namespace URI to match, or null
to
select matching rules regardless of namespace URIpattern
- Pattern to be matched
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |