Uses of Class
org.apache.commons.digester.Digester
Packages that use Digester
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
plugins
package provides an easy mechanism whereby new
digestion rules can be added dynamically during a digestion.The
plugins.strategies
package contains "rule-finding" strategy
classes, and their associated "helper" loader classes.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 Digester in org.apache.commons.digester
Fields in org.apache.commons.digester declared as DigesterModifier and TypeFieldDescriptionprotected Digester
AbstractObjectCreationFactory.digester
The associatedDigester
instance that was set up byFactoryCreateRule
upon initialization.private Digester
AbstractRulesImpl.digester
Digester using thisRules
implementationprotected Digester
Rule.digester
The Digester with which this Rule is associated.protected Digester
RulesBase.digester
The Digester instance with which this Rules instance is associated.Methods in org.apache.commons.digester that return DigesterModifier and TypeMethodDescriptionAbstractObjectCreationFactory.getDigester()
Returns theDigester
that was set by theFactoryCreateRule
upon initialization.AbstractRulesImpl.getDigester()
Return the Digester instance with which this Rules instance is associated.ObjectCreationFactory.getDigester()
Returns theDigester
that was set by theFactoryCreateRule
upon initialization.Rule.getDigester()
Return the Digester with which this Rule is associated.Rules.getDigester()
Return the Digester instance with which this Rules instance is associated.RulesBase.getDigester()
Return the Digester instance with which this Rules instance is associated.SetNestedPropertiesRule.AnyChildRules.getDigester()
WithDefaultsRulesWrapper.getDigester()
Gets digester using these RulesMethods in org.apache.commons.digester with parameters of type DigesterModifier and TypeMethodDescriptionvoid
RuleSet.addRuleInstances
(Digester digester) Add the set of Rule instances defined in this RuleSet to the specifiedDigester
instance, associating them with our namespace URI (if any).abstract void
RuleSetBase.addRuleInstances
(Digester digester) Add the set of Rule instances defined in this RuleSet to the specifiedDigester
instance, associating them with our namespace URI (if any).Invoked just after an object has been popped from a digester stack.Invoked just before an object is to be pushed onto a digester stack.void
AbstractObjectCreationFactory.setDigester
(Digester digester) Set theDigester
to allow the implementation to do logging, classloading based on the digester's classloader, etc.void
AbstractRulesImpl.setDigester
(Digester digester) Set the Digester instance with which this Rules instance is associated.void
CallMethodRule.setDigester
(Digester digester) Set the associated digester.void
ObjectCreationFactory.setDigester
(Digester digester) Set theDigester
to allow the implementation to do logging, classloading based on the digester's classloader, etc.void
Rule.setDigester
(Digester digester) Set theDigester
with which thisRule
is associated.void
Rules.setDigester
(Digester digester) Set the Digester instance with which this Rules instance is associated.void
RulesBase.setDigester
(Digester digester) Set the Digester instance with which this Rules instance is associated.void
SetNestedPropertiesRule.AnyChildRules.setDigester
(Digester digester) void
SetNestedPropertiesRule.setDigester
(Digester digester) Invoked when rule is added to digester.void
WithDefaultsRulesWrapper.setDigester
(Digester digester) Sets digeseter using these RulesConstructors in org.apache.commons.digester with parameters of type DigesterModifierConstructorDescriptionBeanPropertySetterRule
(Digester digester) Deprecated.BeanPropertySetterRule
(Digester digester, String propertyName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.CallMethodRule
(Digester digester, String methodName, int paramCount) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.CallMethodRule
(Digester digester, String methodName, int paramCount, Class<?>[] paramTypes) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.CallMethodRule
(Digester digester, String methodName, int paramCount, String[] paramTypes) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.CallParamRule
(Digester digester, int paramIndex) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.CallParamRule
(Digester digester, int paramIndex, String attributeName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.FactoryCreateRule
(Digester digester, Class<?> clazz) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.FactoryCreateRule
(Digester digester, Class<?> clazz, String attributeName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.FactoryCreateRule
(Digester digester, String className) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.FactoryCreateRule
(Digester digester, String className, String attributeName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.FactoryCreateRule
(Digester digester, ObjectCreationFactory creationFactory) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.ObjectCreateRule
(Digester digester, Class<?> clazz) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.ObjectCreateRule
(Digester digester, String className) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.ObjectCreateRule
(Digester digester, String attributeName, Class<?> clazz) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.ObjectCreateRule
(Digester digester, String className, String attributeName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetNextRule
(Digester digester, String methodName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetNextRule
(Digester digester, String methodName, String paramType) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetPropertiesRule
(Digester digester) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetPropertyRule
(Digester digester, String name, String value) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetRootRule
(Digester digester, String methodName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetRootRule
(Digester digester, String methodName, String paramType) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetTopRule
(Digester digester, String methodName) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method.SetTopRule
(Digester digester, String methodName, String paramType) Deprecated.The digester instance is now set in theaddRule(java.lang.String, org.apache.commons.digester.Rule)
method. -
Uses of Digester in org.apache.commons.digester.annotations
Methods in org.apache.commons.digester.annotations that return DigesterModifier and TypeMethodDescriptionDigesterLoader.createDigester
(Class<?> target) Creates a new digester which rules are defined by analyzing the digester annotations in the target class.Methods in org.apache.commons.digester.annotations with parameters of type DigesterModifier and TypeMethodDescriptionvoid
FromAnnotationsRuleSet.addRuleInstances
(Digester digester) Add the set of Rule instances defined in this RuleSet to the specifiedDigester
instance, associating them with our namespace URI (if any).void
Add rules to an already created Digester instance, analyzing the digester annotations in the target class. -
Uses of Digester in org.apache.commons.digester.plugins
Fields in org.apache.commons.digester.plugins declared as DigesterModifier and TypeFieldDescriptionprotected Digester
PluginRules.digester
The Digester instance with which this Rules instance is associated.Methods in org.apache.commons.digester.plugins that return DigesterModifier and TypeMethodDescriptionPluginRules.getDigester()
Return the Digester instance with which this instance is associated.Methods in org.apache.commons.digester.plugins with parameters of type DigesterModifier and TypeMethodDescriptionabstract void
Configures the digester with custom rules for some plugged-in class.void
Attempt to load custom rules for the target class at the specified pattern.static void
PluginDeclarationRule.declarePlugin
(Digester digester, Properties props) PluginManager.findLoader
(Digester digester, String id, Class<?> pluginClass, Properties props) Given a plugin class and some associated properties, scan the list of known RuleFinder instances until one detects a source of custom rules for this plugin (aka a RuleLoader).abstract RuleLoader
RuleFinder.findLoader
(Digester d, Class<?> pluginClass, Properties p) Apply the finder algorithm to attempt to locate a source of digester rules for the specified plugin class.(package private) static org.apache.commons.logging.Log
Get the Log object associated with the specified Digester instance, or a "no-op" logging object if the digester reference is null.void
Declaration.init
(Digester digester, PluginManager pm) Must be called exactly once, and must be called before any call to the configure method.abstract Rules
Return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing rules.void
PluginRules.setDigester
(Digester digester) Set the Digester instance with which this Rules instance is associated.Constructors in org.apache.commons.digester.plugins with parameters of type DigesterModifierConstructorDescription(package private)
PluginRules
(Digester digester, String mountPoint, PluginRules parent, Class<?> pluginClass) Constructs a Rules instance which has a parent Rules object (which is different from having a delegate rules object). -
Uses of Digester in org.apache.commons.digester.plugins.strategies
Methods in org.apache.commons.digester.plugins.strategies with parameters of type DigesterModifier and TypeMethodDescriptionvoid
Just invoke the target method.void
Add the rules previously loaded from the input stream into the specified digester.void
Just add a SetPropertiesRule at the specified path.FinderFromClass.findLoader
(Digester digester, Class<?> pluginClass, Properties p) If there exists a property with the name matching constructor param ruleClassAttr, then load the specified class, locate the appropriate rules-adding method on that class, and return an object encapsulating that info.FinderFromDfltClass.findLoader
(Digester digester, Class<?> pluginClass, Properties p) If there exists a class whose name is the plugin class name + the suffix specified to the constructor, then load that class, locate the appropriate rules-adding method on that class, and return an object encapsulating that info.FinderFromDfltMethod.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists on the plugin class a method with name matching the constructor's methodName value then locate the appropriate Method on the plugin class and return an object encapsulating that info.FinderFromDfltResource.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a resource file whose name is equal to the plugin class name + the suffix specified in the constructor, then load that file, run it through the xmlrules module and return an object encapsulating those rules.FinderFromFile.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a property with the name specified in the constructor, then load that file, run it through the xmlrules module and return an object encapsulating those rules.FinderFromMethod.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a property with the name matching constructor param methodAttr, then locate the appropriate Method on the plugin class and return an object encapsulating that info.FinderFromResource.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a property with the name matching constructor param resourceAttr, then load that file, run it through the xmlrules module and return an object encapsulating those rules.FinderSetProperties.findLoader
(Digester d, Class<?> pluginClass, Properties p) Returns a RuleLoader unless the properties contain an entry with the name matching constructor param propsAttr, and the value matching what is in falseval.static RuleLoader
FinderFromResource.loadRules
(Digester d, Class<?> pluginClass, InputStream is, String resourceName) Open the specified resource file (ie a file in the classpath, including being within a jar in the classpath), run it through the xmlrules module and return an object encapsulating those rules. -
Uses of Digester in org.apache.commons.digester.xmlrules
Fields in org.apache.commons.digester.xmlrules declared as DigesterModifier and TypeFieldDescriptionprivate Digester
FromXmlRuleSet.rulesDigester
The digester for loading the rules xml.protected Digester
DigesterRuleParser.targetDigester
This is the digester to which we are adding the rules that we parse from the Rules XML document.Methods in org.apache.commons.digester.xmlrules that return DigesterModifier and TypeMethodDescriptionstatic Digester
DigesterLoader.createDigester
(URL rulesXml) Creates a new digester and initializes it from the specified XML filestatic Digester
DigesterLoader.createDigester
(URL rulesXml, Digester rulesDigester) Creates a new digester and initializes it from the specified XML file.static Digester
DigesterLoader.createDigester
(InputSource rulesSource) Creates a new digester and initializes it from the specified InputSourcestatic Digester
DigesterLoader.createDigester
(InputSource rulesSource, Digester rulesDigester) Creates a new digester and initializes it from the specified InputSource.DigesterRuleParser.RulesPrefixAdapter.getDigester()
This method passes through to the underlying Rules object.Methods in org.apache.commons.digester.xmlrules with parameters of type DigesterModifier and TypeMethodDescriptionvoid
DigesterRuleParser.addRuleInstances
(Digester digester) Add to the given digester the set of Rule instances used to parse an XML document defining Digester rules.void
FromXmlRuleSet.addRuleInstances
(Digester digester) Adds to the digester the set of Rule instances defined in the XML file for this rule set.void
FromXmlRuleSet.addRuleInstances
(Digester digester, String basePath) Adds to the digester the set of Rule instances defined in the XML file for this rule set.static Digester
DigesterLoader.createDigester
(URL rulesXml, Digester rulesDigester) Creates a new digester and initializes it from the specified XML file.static Digester
DigesterLoader.createDigester
(InputSource rulesSource, Digester rulesDigester) Creates a new digester and initializes it from the specified InputSource.void
Creates and adds Digester Rules to a given Rules objectprivate void
FromXmlRuleSet.init
(FromXmlRuleSet.XMLRulesLoader rulesLoader, DigesterRuleParser parser, Digester rulesDigester) Base constructorvoid
DigesterRuleParser.RulesPrefixAdapter.setDigester
(Digester digester) This method passes through to the underlying Rules object.void
Sets the digester into which to add the parsed rulesConstructors in org.apache.commons.digester.xmlrules with parameters of type DigesterModifierConstructorDescriptionDigesterRuleParser
(Digester targetDigester) Constructs a rule set for converting XML digester rule descriptions into Rule objects, and adding them to the given Digesterprivate
DigesterRuleParser
(Digester targetDigester, DigesterRuleParser.PatternStack<String> stack, Set<String> includedFiles) Constructs a rule set for parsing an XML digester rule file that has been included within an outer XML digester rule file.FromXmlRuleSet
(URL rulesXml, Digester rulesDigester) Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.FromXmlRuleSet
(URL rulesXml, DigesterRuleParser parser, Digester rulesDigester) FromXmlRuleSet
(InputSource inputSource, Digester rulesDigester) Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.FromXmlRuleSet
(InputSource inputSource, DigesterRuleParser parser, Digester rulesDigester)
addRule(java.lang.String, org.apache.commons.digester.Rule)
method.