Uses of Class
org.apache.commons.digester3.Rule

Packages that use Rule
org.apache.commons.digester3 The xmlrules package provides for XML-based definition of rules for Digester
org.apache.commons.digester3.binder The Digester EDSL allows configure Digester using fluent APIs. 
org.apache.commons.digester3.plugins The plugins package provides an easy mechanism whereby new digestion rules can be added dynamically during a digestion. 
 

Uses of Rule in org.apache.commons.digester3
 

Subclasses of Rule in org.apache.commons.digester3
 class AbstractMethodRule
          Abstract implementation for SetNextRule, SetRootRule and SetTopRule rules.
 class BeanPropertySetterRule
           Rule implements sets a bean property on the top object to the body text.
 class CallMethodRule
           Rule implementation that calls a method on an object on the stack (normally the top/parent object), passing arguments collected from subsequent CallParamRule rules or from the body of this element.
 class CallParamRule
           Rule implementation that saves a parameter for use by a surrounding CallMethodRule.
 class FactoryCreateRule
           Rule implementation that uses an ObjectCreationFactory to create a new object which it pushes onto the object stack.
 class NodeCreateRule
          A rule implementation that creates a DOM Node containing the XML at the element that matched the rule.
 class ObjectCreateRule
          Rule implementation that creates a new object and pushes it onto the object stack.
 class ObjectParamRule
           Rule implementation that saves a parameter for use by a surrounding CallMethodRule.
 class PathCallParamRule
           Rule implementation that saves a parameter containing the Digester matching path for use by a surrounding CallMethodRule.
 class SetNestedPropertiesRule
           Rule implementation that sets properties on the object at the top of the stack, based on child elements with names matching properties on that object.
 class SetNextRule
           Rule implementation that calls a method on the (top-1) (parent) object, passing the top object (child) as an argument.
 class SetPropertiesRule
           Rule implementation that sets properties on the object at the top of the stack, based on attributes with corresponding names.
 class SetPropertyRule
          Rule implementation that sets an individual property on the object at the top of the stack, based on attributes with specified names.
 class SetRootRule
           Rule implementation that calls a method on the root object on the stack, passing the top object (child) as an argument.
 class SetTopRule
           Rule implementation that calls a "set parent" method on the top (child) object, passing the (top-1) (parent) object as an argument.
 

Fields in org.apache.commons.digester3 with type parameters of type Rule
protected  HashMap<String,List<Rule>> RulesBase.cache
          The set of registered Rule instances, keyed by the matching pattern.
protected  ArrayList<Rule> RulesBase.rules
          The set of registered Rule instances, in the order that they were originally registered.
 

Methods in org.apache.commons.digester3 that return types with arguments of type Rule
 List<Rule> WithDefaultsRulesWrapper.getDefaults()
          Gets Rule's which will be fired when the wrapped implementation returns no matches
 Stack<List<Rule>> Digester.getMatches()
          Return a Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().
protected  List<Rule> RulesBase.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> WithDefaultsRulesWrapper.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> RulesBase.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.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> RegexRules.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> ExtendedBaseRules.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> WithDefaultsRulesWrapper.rules()
          Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
 List<Rule> RulesBase.rules()
          Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
 List<Rule> Rules.rules()
          Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
 List<Rule> RegexRules.rules()
          Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
 

Methods in org.apache.commons.digester3 with parameters of type Rule
 void WithDefaultsRulesWrapper.add(String pattern, Rule rule)
          Register a new Rule instance matching the specified pattern.
 void Rules.add(String pattern, Rule rule)
          Register a new Rule instance matching the specified pattern.
 void AbstractRulesImpl.add(String pattern, Rule rule)
          Register a new Rule instance matching the specified pattern.
 void WithDefaultsRulesWrapper.addDefault(Rule rule)
          Adds a rule to be fired when wrapped implementation returns no matches
 void Digester.addRule(String pattern, Rule rule)
           Register a new Rule matching the specified pattern.
protected  void RulesBase.registerRule(String pattern, Rule rule)
          Register rule at given pattern.
protected  void RegexRules.registerRule(String pattern, Rule rule)
          Register rule at given pattern.
protected  void ExtendedBaseRules.registerRule(String pattern, Rule rule)
          Register rule at given pattern.
protected abstract  void AbstractRulesImpl.registerRule(String pattern, Rule rule)
          Register rule at given pattern.
 

Uses of Rule in org.apache.commons.digester3.binder
 

Classes in org.apache.commons.digester3.binder with type parameters of type Rule
 class ByRuleBuilder<R extends Rule>
          Builder chained when invoking LinkedRuleBuilder.addRule(Rule).
 class ByRuleProviderBuilder<R extends Rule>
          Builder chained when invoking LinkedRuleBuilder.addRuleCreatedBy(org.apache.commons.digester3.binder.RuleProvider).
 interface RuleProvider<R extends Rule>
          An object capable of providing instances of Rule.
 

Methods in org.apache.commons.digester3.binder with type parameters of type Rule
<R extends Rule>
ByRuleBuilder<R>
LinkedRuleBuilder.addRule(R rule)
          Add a custom user rule in the specified pattern.
<R extends Rule>
ByRuleProviderBuilder<R>
LinkedRuleBuilder.addRuleCreatedBy(RuleProvider<R> provider)
          Add a custom user rule in the specified pattern built by the given provider.
 

Uses of Rule in org.apache.commons.digester3.plugins
 

Subclasses of Rule in org.apache.commons.digester3.plugins
 class PluginCreateRule
          Allows the original rules for parsing the configuration file to define points at which plugins are allowed, by configuring a PluginCreateRule with the appropriate pattern.
 class PluginDeclarationRule
          A Digester rule which allows the user to pre-declare a class which is to be referenced later at a plugin point by a PluginCreateRule.
 

Methods in org.apache.commons.digester3.plugins that return types with arguments of type Rule
 List<Rule> PluginRules.match(String namespaceURI, String path, 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> PluginRules.rules()
          Return the list of rules registered with this object, in the order they were registered with this object.
 

Methods in org.apache.commons.digester3.plugins with parameters of type Rule
 void PluginRules.add(String pattern, Rule rule)
          Register a new Rule instance matching the specified pattern.
 

Method parameters in org.apache.commons.digester3.plugins with type arguments of type Rule
 void PluginCreateRule.fireBeginMethods(List<Rule> rules, String namespace, String name, Attributes list)
          Duplicate the processing that the Digester does when firing the begin methods of rules.
 void PluginCreateRule.fireEndMethods(List<Rule> rules, String namespaceURI, String name)
          Duplicate the processing that the Digester does when firing the end methods of rules.
 



Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.