Uses of Class
org.apache.commons.digester3.Rule
Packages that use Rule
Package
Description
The
xmlrules
package provides for XML-based definition of
rules for Digester
.The
annotations
package provides for Java5 Annotations
meta data-based definition of rules for Digester
.The Digester EDSL allows configure Digester using fluent APIs.
The
plugins
package provides an easy mechanism whereby new
digestion rules can be added dynamically during a digestion.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.digester3Modifier and TypeClassDescriptionclass
class
Rule implements sets a bean property on the top object to the body text.class
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
Rule implementation that saves a parameter for use by a surroundingCallMethodRule
.
class
Rule implementation that uses anObjectCreationFactory
to create a new object which it pushes onto the object stack.class
A rule implementation that creates a DOMNode
containing the XML at the element that matched the rule.class
Rule implementation that creates a new object and pushes it onto the object stack.class
Rule implementation that saves a parameter for use by a surroundingCallMethodRule
.
class
Rule implementation that saves a parameter containing theDigester
matching path for use by a surroundingCallMethodRule
.class
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
class
Rule implementation that calls a method on the (top-1) (parent) object, passing the top object (child) as an argument.class
Rule implementation that sets properties on the object at the top of the stack, based on attributes with corresponding names.class
Rule implementation that sets an individual property on the object at the top of the stack, based on attributes with specified names.class
Rule implementation that calls a method on the root object on the stack, passing the top object (child) as an argument.class
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 RuleFields in org.apache.commons.digester3 with type parameters of type RuleModifier and TypeFieldDescriptionWithDefaultsRulesWrapper.allRules
All rules (preserves order in which they were originally added)RulesBase.cache
The set of registered Rule instances, keyed by the matching pattern.WithDefaultsRulesWrapper.defaultRules
Rules to be fired when the wrapped implementations returns none.Digester.matches
Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().ExtendedBaseRules.order
The decision algorithm used (unfortunately) doesn't preserve the entry order.RulesBase.rules
The set of registered Rule instances, in the order that they were originally registered.SetNestedPropertiesRule.AnyChildRules.rules
Methods in org.apache.commons.digester3 that return types with arguments of type RuleModifier and TypeMethodDescriptionExtendedBaseRules.findExactAncesterMatch
(String parentPattern) Finds an exact ancester match for given patternWithDefaultsRulesWrapper.getDefaults()
Gets Rule's which will be fired when the wrapped implementation returns no matchesDigester.getMatches()
Return a Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any).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.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.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.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.SetNestedPropertiesRule.AnyChildRules.match
(String namespaceURI, String matchPath, String name, Attributes attributes) 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.RegexRules.rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.Rules.rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.RulesBase.rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.SetNestedPropertiesRule.AnyChildRules.rules()
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 RuleModifier and TypeMethodDescriptionfinal void
Register a new Rule instance matching the specified pattern.void
Register a new Rule instance matching the specified pattern.void
void
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
Register a new Rule matching the specified pattern.protected abstract void
AbstractRulesImpl.registerRule
(String pattern, Rule rule) Register rule at given pattern.protected void
ExtendedBaseRules.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
RulesBase.registerRule
(String pattern, Rule rule) Register rule at given pattern.Constructors in org.apache.commons.digester3 with parameters of type Rule -
Uses of Rule in org.apache.commons.digester3.annotations
Methods in org.apache.commons.digester3.annotations with type parameters of type RuleModifier and TypeMethodDescriptionprivate <A extends Annotation,
E extends 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. -
Uses of Rule in org.apache.commons.digester3.binder
Classes in org.apache.commons.digester3.binder with type parameters of type RuleModifier and TypeClassDescription(package private) class
AbstractBackToLinkedRuleBuilder<R extends Rule>
Builder invoked to back to mainLinkedRuleBuilder
.final class
ByRuleBuilder<R extends Rule>
Builder chained when invokingLinkedRuleBuilder.addRule(Rule)
.final 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 RuleFields in org.apache.commons.digester3.binder with type parameters of type RuleModifier and TypeFieldDescriptionprivate final Collection
<AbstractBackToLinkedRuleBuilder<? extends Rule>> FromBinderRuleSet.providers
The data structure where storing the providers binding.private final Map
<FromBinderRuleSet.Key, Collection<AbstractBackToLinkedRuleBuilder<? extends Rule>>> FromBinderRuleSet.providersIndex
Index for quick-retrieve provider.Methods in org.apache.commons.digester3.binder with type parameters of type RuleModifier and TypeMethodDescriptionprivate <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
(String keyPattern, String namespaceURI, 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.pluginsModifier and TypeClassDescriptionclass
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
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 RuleModifier and TypeMethodDescriptionPluginRules.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.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 RuleModifier and TypeMethodDescriptionvoid
Register a new Rule instance matching the specified pattern.Method parameters in org.apache.commons.digester3.plugins with type arguments of type RuleModifier and TypeMethodDescriptionvoid
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.private void
Duplicate the processing that the Digester does when firing thebody(String, String, String)
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. -
Uses of Rule in org.apache.commons.digester3.xmlrules
Subclasses of Rule in org.apache.commons.digester3.xmlrulesModifier and TypeClassDescription(package private) class
(package private) class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
A rule for including one rules XML file within another.(package private) final class
(package private) final class
(package private) final class
(package private) class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class
(package private) final class