|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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 HashMap<String,List<Rule>> |
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 String |
namespaceURI
The namespace URI for which subsequently added Rule
objects are relevant, or null for matching independent
of namespaces. |
protected ArrayList<Rule> |
rules
The set of registered Rule instances, in the order that they were originally registered. |
| Constructor Summary | |
|---|---|
RulesBase()
|
|
| Method Summary | |
|---|---|
void |
add(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. |
String |
getNamespaceURI()
Return the namespace URI that will be applied to all subsequently added Rule objects. |
protected List<Rule> |
lookup(String namespaceURI,
String pattern)
Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any). |
List<Rule> |
match(String pattern)
Deprecated. Call match(namespaceURI,pattern) instead. |
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. |
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 added Rule objects. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected HashMap<String,List<Rule>> cache
protected Digester digester
protected String namespaceURI
Rule
objects are relevant, or null for matching independent
of namespaces.
protected ArrayList<Rule> rules
| Constructor Detail |
|---|
public RulesBase()
| Method Detail |
|---|
public Digester getDigester()
getDigester in interface Rulespublic void setDigester(Digester digester)
setDigester in interface Rulesdigester - The newly associated Digester instancepublic String getNamespaceURI()
Rule objects.
getNamespaceURI in interface Rulespublic void setNamespaceURI(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(String pattern,
Rule rule)
add in interface Rulespattern - Nesting pattern to be matched for this Rulerule - Rule instance to be registeredpublic void clear()
clear in interface Rules@Deprecated public List<Rule> match(String pattern)
add()
method.
match in interface Rulespattern - Nesting pattern to be matched
public List<Rule> match(String namespaceURI,
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 List<Rule> rules()
add()
method.
rules in interface Rules
protected List<Rule> lookup(String namespaceURI,
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 | |||||||||