Uses of Class
org.apache.commons.digester3.Rule
-
Packages that use Rule Package Description org.apache.commons.digester3 Thexmlrules
package provides for XML-based definition of rules forDigester
.org.apache.commons.digester3.annotations Theannotations
package provides for Java5 Annotations meta data-based definition of rules forDigester
.org.apache.commons.digester3.binder The Digester EDSL allows configure Digester using fluent APIs.org.apache.commons.digester3.plugins Theplugins
package provides an easy mechanism whereby new digestion rules can be added dynamically during a digestion.org.apache.commons.digester3.xmlrules The Digester package lets you configure an XML -> Java object mapping module, which triggers certain actions called rules whenever a particular pattern of nested XML elements is recognized. -
-
Uses of Rule in org.apache.commons.digester3
Subclasses of Rule in org.apache.commons.digester3 Modifier and Type Class Description class
AbstractMethodRule
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 subsequentCallParamRule
rules or from the body of this element.class
CallParamRule
Rule implementation that saves a parameter for use by a surroundingCallMethodRule
.
class
FactoryCreateRule
Rule implementation that uses anObjectCreationFactory
to create a new object which it pushes onto the object stack.class
NodeCreateRule
A rule implementation that creates a DOMNode
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 surroundingCallMethodRule
.
class
PathCallParamRule
Rule implementation that saves a parameter containing theDigester
matching path for use by a surroundingCallMethodRule
.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.private class
SetNestedPropertiesRule.AnyChildRule
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 declared as Rule Modifier and Type Field Description (package private) Rule
RegexRules.RegisteredRule. rule
Fields in org.apache.commons.digester3 with type parameters of type Rule Modifier and Type Field Description private java.util.List<Rule>
WithDefaultsRulesWrapper. allRules
All rules (preserves order in which they were originally added)protected java.util.HashMap<java.lang.String,java.util.List<Rule>>
RulesBase. cache
The set of registered Rule instances, keyed by the matching pattern.private java.util.List<Rule>
WithDefaultsRulesWrapper. defaultRules
Rules to be fired when the wrapped implementations returns none.private java.util.Stack<java.util.List<Rule>>
Digester. matches
Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().private java.util.Map<Rule,java.lang.Integer>
ExtendedBaseRules. order
The decision algorithm used (unfortunately) doesn't preserve the entry order.protected java.util.ArrayList<Rule>
RulesBase. rules
The set of registered Rule instances, in the order that they were originally registered.private java.util.ArrayList<Rule>
SetNestedPropertiesRule.AnyChildRules. rules
Methods in org.apache.commons.digester3 that return types with arguments of type Rule Modifier and Type Method Description private java.util.List<Rule>
ExtendedBaseRules. findExactAncesterMatch(java.lang.String parentPattern)
Finds an exact ancester match for given patternjava.util.List<Rule>
WithDefaultsRulesWrapper. getDefaults()
Gets Rule's which will be fired when the wrapped implementation returns no matchesjava.util.Stack<java.util.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 java.util.List<Rule>
RulesBase. 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<Rule>
ExtendedBaseRules. match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.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.java.util.List<Rule>
RegexRules. match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.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.java.util.List<Rule>
Rules. match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.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.java.util.List<Rule>
RulesBase. match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.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.java.util.List<Rule>
SetNestedPropertiesRule.AnyChildRules. match(java.lang.String namespaceURI, java.lang.String matchPath, java.lang.String name, org.xml.sax.Attributes attributes)
java.util.List<Rule>
WithDefaultsRulesWrapper. match(java.lang.String namespaceURI, java.lang.String pattern, java.lang.String name, org.xml.sax.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.java.util.List<Rule>
RegexRules. rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.java.util.List<Rule>
Rules. rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.java.util.List<Rule>
RulesBase. rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.java.util.List<Rule>
SetNestedPropertiesRule.AnyChildRules. rules()
java.util.List<Rule>
WithDefaultsRulesWrapper. 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 Modifier and Type Method Description void
AbstractRulesImpl. add(java.lang.String pattern, Rule rule)
Register a new Rule instance matching the specified pattern.void
Rules. add(java.lang.String pattern, Rule rule)
Register a new Rule instance matching the specified pattern.void
SetNestedPropertiesRule.AnyChildRules. add(java.lang.String pattern, Rule rule)
void
WithDefaultsRulesWrapper. add(java.lang.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 matchesvoid
Digester. addRule(java.lang.String pattern, Rule rule)
Register a new Rule matching the specified pattern.protected abstract void
AbstractRulesImpl. registerRule(java.lang.String pattern, Rule rule)
Register rule at given pattern.protected void
ExtendedBaseRules. registerRule(java.lang.String pattern, Rule rule)
Register rule at given pattern.protected void
RegexRules. registerRule(java.lang.String pattern, Rule rule)
Register rule at given pattern.protected void
RulesBase. registerRule(java.lang.String pattern, Rule rule)
Register rule at given pattern.Constructors in org.apache.commons.digester3 with parameters of type Rule Constructor Description RegisteredRule(java.lang.String pattern, Rule rule)
-
Uses of Rule in org.apache.commons.digester3.annotations
Methods in org.apache.commons.digester3.annotations with type parameters of type Rule Modifier and Type Method Description private <A extends java.lang.annotation.Annotation,E extends java.lang.reflect.AnnotatedElement,R extends Rule>
voidFromAnnotationsRuleModule. handle(A annotation, E element)
Handles the current visited element and related annotation, invoking the right handler putting the rule provider in the rule set.Methods in org.apache.commons.digester3.annotations that return types with arguments of type Rule Modifier and Type Method Description java.lang.Class<? extends Rule>
reflectsRule()
The reflected commons-digester rule. -
Uses of Rule in org.apache.commons.digester3.binder
Classes in org.apache.commons.digester3.binder with type parameters of type Rule Modifier and Type Class Description (package private) class
AbstractBackToLinkedRuleBuilder<R extends Rule>
Builder invoked to back to mainLinkedRuleBuilder
.class
ByRuleBuilder<R extends Rule>
Builder chained when invokingLinkedRuleBuilder.addRule(Rule)
.class
ByRuleProviderBuilder<R extends Rule>
Builder chained when invokingLinkedRuleBuilder.addRuleCreatedBy(org.apache.commons.digester3.binder.RuleProvider)
.interface
RuleProvider<R extends Rule>
An object capable of providing instances ofRule
.Fields in org.apache.commons.digester3.binder declared as Rule Modifier and Type Field Description private R
ByRuleBuilder. rule
Fields in org.apache.commons.digester3.binder with type parameters of type Rule Modifier and Type Field Description private java.util.Collection<AbstractBackToLinkedRuleBuilder<? extends Rule>>
FromBinderRuleSet. providers
The data structure where storing the providers binding.private java.util.Map<FromBinderRuleSet.Key,java.util.Collection<AbstractBackToLinkedRuleBuilder<? extends Rule>>>
FromBinderRuleSet. providersIndex
Index for quick-retrieve provider.Methods in org.apache.commons.digester3.binder with type parameters of type Rule Modifier and Type Method Description private <R extends Rule,RB extends AbstractBackToLinkedRuleBuilder<R>>
RBLinkedRuleBuilder. addProvider(RB provider)
Add a provider in the data structure where storing the providers binding.<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.<R extends Rule,RB extends AbstractBackToLinkedRuleBuilder<R>>
RBFromBinderRuleSet. getProvider(java.lang.String keyPattern, java.lang.String namespaceURI, java.lang.Class<RB> type)
Returns the first instance ofRuleProvider
assignable to the input type.<R extends Rule,RB extends AbstractBackToLinkedRuleBuilder<R>>
voidFromBinderRuleSet. registerProvider(RB ruleBuilder)
Register the given rule builder and returns it. -
Uses of Rule in org.apache.commons.digester3.plugins
Subclasses of Rule in org.apache.commons.digester3.plugins Modifier and Type Class Description 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 Modifier and Type Method Description java.util.List<Rule>
PluginRules. match(java.lang.String namespaceURI, java.lang.String path, java.lang.String name, org.xml.sax.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.java.util.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 Modifier and Type Method Description void
PluginRules. add(java.lang.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 Modifier and Type Method Description void
PluginCreateRule. fireBeginMethods(java.util.List<Rule> rules, java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes list)
Duplicate the processing that the Digester does when firing the begin methods of rules.private void
PluginCreateRule. fireBodyMethods(java.util.List<Rule> rules, java.lang.String namespaceURI, java.lang.String name, java.lang.String text)
Duplicate the processing that the Digester does when firing thebody(String, String, String)
methods of rules.void
PluginCreateRule. fireEndMethods(java.util.List<Rule> rules, java.lang.String namespaceURI, java.lang.String name)
Duplicate the processing that the Digester does when firing the end methods of rules. -
Uses of Rule in org.apache.commons.digester3.xmlrules
Subclasses of Rule in org.apache.commons.digester3.xmlrules Modifier and Type Class Description (package private) class
AbstractXmlMethodRule
(package private) class
AbstractXmlRule
(package private) class
BeanPropertySetterRule
(package private) class
CallMethodRule
(package private) class
CallParamRule
(package private) class
FactoryCreateRule
(package private) class
IncludeRule
A rule for including one rules XML file within another.(package private) class
NodeCreateRule
(package private) class
ObjectCreateRule
(package private) class
ObjectParamRule
(package private) class
PatternRule
(package private) class
SetNamespaceURIRule
(package private) class
SetNestedPropertiesAliasRule
(package private) class
SetNestedPropertiesIgnoreRule
(package private) class
SetNestedPropertiesRule
(package private) class
SetNextRule
(package private) class
SetPropertiesAliasRule
(package private) class
SetPropertiesIgnoreRule
(package private) class
SetPropertiesRule
(package private) class
SetPropertyRule
(package private) class
SetRootRule
(package private) class
SetTopRule
-