Save This Page
Home » commons-digester-1.8-src » org.apache.commons » digester » [javadoc | source]
org.apache.commons.digester
public class: WithDefaultsRulesWrapper [javadoc | source]
java.lang.Object
   org.apache.commons.digester.WithDefaultsRulesWrapper

All Implemented Interfaces:
    Rules

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:
 public WithDefaultsRulesWrapper(Rules wrappedRules) 
    Base constructor.
    Parameters:
    wrappedRules - the wrapped Rules implementation, not null
    Throws:
    IllegalArgumentException - when wrappedRules is null
Method from org.apache.commons.digester.WithDefaultsRulesWrapper Summary:
add,   addDefault,   clear,   getDefaults,   getDigester,   getNamespaceURI,   match,   match,   rules,   setDigester,   setNamespaceURI
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.digester.WithDefaultsRulesWrapper Detail:
 public  void add(String pattern,
    Rule rule) 
    Adds a Rule to be fired on given pattern. Pattern matching is delegated to wrapped implementation.
 public  void addDefault(Rule rule) 
    Adds a rule to be fired when wrapped implementation returns no matches
 public  void clear() 
    Clears all Rule's
 public List getDefaults() 
    Gets Rule's which will be fired when the wrapped implementation returns no matches
 public Digester getDigester() 
    Gets digester using these Rules
 public String getNamespaceURI() 
    Gets namespace to apply to Rule's added
 public List match(String pattern) 
 public List match(String namespaceURI,
    String pattern) 
    Return list of rules matching given pattern. If wrapped implementation returns any matches return those. Otherwise, return default matches.
 public List rules() 
    Gets all rules
 public  void setDigester(Digester digester) 
    Sets digeseter using these Rules
 public  void setNamespaceURI(String namespaceURI) 
    Sets namespace to apply to Rule's added subsequently