Uses of Class
org.apache.commons.digester.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
handlers
package contains
DigesterLoaderHandler
implementations.This package contains internal use only classes, users can ignore it.
Contains annotations package SPI definition.
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.digester
Subclasses of Rule in org.apache.commons.digesterModifier and TypeClassDescriptionclass
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.digester declared as RuleFields in org.apache.commons.digester 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.digester 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 matchesDeprecated.Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any).Deprecated.Call match(namespaceURI,pattern) instead.Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.Finds matching rules by using current regex matching strategy.Deprecated.Call match(namespaceURI,pattern) instead.Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.Deprecated.Call match(namespaceURI,pattern) instead.Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.Return list of rules matching given pattern.AbstractRulesImpl.rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.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()
Gets all rulesMethods in org.apache.commons.digester with parameters of type RuleModifier and TypeMethodDescriptionvoid
Registers a new Rule instance matching the specified pattern.void
Register a new Rule instance matching the specified pattern.void
Register a new Rule instance matching the specified pattern.void
Register a new Rule instance matching the specified pattern.void
void
Adds a Rule to be fired on given 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
RegexRules.registerRule
(String pattern, Rule rule) Register a new Rule instance matching the specified pattern.Constructors in org.apache.commons.digester with parameters of type Rule -
Uses of Rule in org.apache.commons.digester.annotations
Classes in org.apache.commons.digester.annotations with type parameters of type RuleModifier and TypeInterfaceDescriptioninterface
AnnotationRuleProvider<A extends Annotation,
E extends AnnotatedElement, R extends Rule> An object capable of providing instances ofRule
.Fields in org.apache.commons.digester.annotations with type parameters of type RuleModifier and TypeFieldDescriptionprivate final Map
<String, List<AnnotationRuleProvider<Annotation, AnnotatedElement, Rule>>> FromAnnotationsRuleSet.rules
The data structure that stores the patterns/AnnotationRuleProvider
pairs.Methods in org.apache.commons.digester.annotations with type parameters of type RuleModifier and TypeMethodDescription<A extends Annotation,
E extends AnnotatedElement, R extends Rule, T extends AnnotationRuleProvider<A, E, R>>
voidFromAnnotationsRuleSet.addRuleProvider
(String pattern, Class<T> klass, A annotation, E element) Builds and register anAnnotationRuleProvider
for a specific pattern.<T extends AnnotationRuleProvider<? extends Annotation,
? extends AnnotatedElement, ? extends Rule>>
TFromAnnotationsRuleSet.getProvider
(String pattern, Class<T> providerClass) Retrieves a specific instance of theAnnotationRuleProvider
for the input pattern.private <A extends Annotation,
E extends AnnotatedElement, R extends Rule>
voidDigesterLoader.handle
(A annotation, E element, FromAnnotationsRuleSet ruleSet) 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.digester.annotations that return types with arguments of type RuleModifier and TypeMethodDescriptionprivate Map
<String, List<AnnotationRuleProvider<Annotation, AnnotatedElement, Rule>>> FromAnnotationsRuleSet.getRules()
Returns the data structure the patterns/AnnotationRuleProvider
pairs.Method parameters in org.apache.commons.digester.annotations with type arguments of type RuleModifier and TypeMethodDescriptionvoid
FromAnnotationsRuleSet.addRuleProvider
(String pattern, AnnotationRuleProvider<? extends Annotation, ? extends AnnotatedElement, ? extends Rule> ruleProvider) Register anAnnotationRuleProvider
for a specific pattern. -
Uses of Rule in org.apache.commons.digester.annotations.handlers
Methods in org.apache.commons.digester.annotations.handlers with type parameters of type RuleModifier and TypeMethodDescriptionprivate <A extends Annotation,
R extends Rule>
voidMethodHandler.doHandle
(A methodAnnotation, Annotation annotation, Method method, Class<?> type, FromAnnotationsRuleSet ruleSet) -
Uses of Rule in org.apache.commons.digester.annotations.internal
Methods in org.apache.commons.digester.annotations.internal with type parameters of type RuleModifier and TypeMethodDescription<T extends AnnotationRuleProvider<? extends Annotation,
? extends AnnotatedElement, ? extends Rule>>
TDefaultAnnotationRuleProviderFactory.newInstance
(Class<T> type) Return anAnnotationRuleProvider
instance of the specified type. -
Uses of Rule in org.apache.commons.digester.annotations.spi
Methods in org.apache.commons.digester.annotations.spi with type parameters of type RuleModifier and TypeMethodDescription<T extends AnnotationRuleProvider<? extends Annotation,
? extends AnnotatedElement, ? extends Rule>>
TAnnotationRuleProviderFactory.newInstance
(Class<T> type) Return anAnnotationRuleProvider
instance of the specified type. -
Uses of Rule in org.apache.commons.digester.plugins
Subclasses of Rule in org.apache.commons.digester.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.digester.plugins that return types with arguments of type RuleModifier and TypeMethodDescriptionDeprecated.Call match(namespaceURI,pattern) instead.Return a List of all registered Rule instances that match the specified nodepath, 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.digester.plugins with parameters of type RuleModifier and TypeMethodDescriptionvoid
Register a new Rule instance matching the specified pattern.Method parameters in org.apache.commons.digester.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 the body 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.digester.xmlrules
Subclasses of Rule in org.apache.commons.digester.xmlrulesModifier and TypeClassDescriptionprivate class
A rule for including one rules XML file within another.private class
A rule for extracting the pattern matching strings from the rules XML.protected class
A rule for adding a attribute-property alias to the custom alias mappings of the containing SetNestedPropertiesRule rule.protected class
A rule for adding a attribute-property alias to the custom alias mappings of the containing SetPropertiesRule rule.Methods in org.apache.commons.digester.xmlrules that return types with arguments of type RuleModifier and TypeMethodDescriptionDeprecated.Call match(namespaceURI,pattern) instead.This method passes through to the underlying Rules object.DigesterRuleParser.RulesPrefixAdapter.rules()
This method passes through to the underlying Rules object.Methods in org.apache.commons.digester.xmlrules with parameters of type RuleModifier and TypeMethodDescriptionvoid
Adds a rule the the target digester.void
Register a new Rule instance matching a pattern which is constructed by concatenating the pattern prefix with the given pattern.
match()
on theRules
implementation returned bygetRules()