|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.digester3.WithDefaultsRulesWrapper
public class WithDefaultsRulesWrapper
Rules Decorator that returns default rules when no matches are returned by the wrapped
implementation.
This allows default Rule instances to be added to any existing Rules implementation. These
default Rule instances will be returned for any match for which the wrapped implementation does not
return any matches.
For example,
Rule alpha; ... WithDefaultsRulesWrapper rules = new WithDefaultsRulesWrapper(new BaseRules()); rules.addDefault(alpha); ... digester.setRules(rules); ...when a pattern does not match any other rule, then rule alpha will be called.
WithDefaultsRulesWrapper follows the Decorator pattern.
| Constructor Summary | |
|---|---|
WithDefaultsRulesWrapper(Rules wrappedRules)
Base constructor. |
|
| Method Summary | |
|---|---|
void |
add(String pattern,
Rule rule)
Register a new Rule instance matching the specified pattern. |
void |
addDefault(Rule rule)
Adds a rule to be fired when wrapped implementation returns no matches |
void |
clear()
Clear all existing Rule instance registrations. |
List<Rule> |
getDefaults()
Gets Rule's which will be fired when the wrapped implementation returns no matches |
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<Rule> |
match(String namespaceURI,
String pattern,
String name,
Attributes attributes)
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 |
| Constructor Detail |
|---|
public WithDefaultsRulesWrapper(Rules wrappedRules)
wrappedRules - the wrapped Rules implementation, not null| 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 RulesRule objects.public 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 URIpublic List<Rule> getDefaults()
public List<Rule> match(String namespaceURI,
String pattern,
String name,
Attributes attributes)
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 matchedname - the local name if the parser is namespace aware, or just the element name otherwiseattributes - The attribute list of the current matching element
public void addDefault(Rule rule)
rule - a Rule to be fired when wrapped implementation returns no matchespublic List<Rule> rules()
add() method.
rules in interface Rulespublic void clear()
clear in interface Rules
public void add(String pattern,
Rule rule)
add in interface Rulespattern - Nesting pattern to be matched for this Rulerule - Rule instance to be registered
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||