Uses of Class
org.apache.commons.digester.Digester

Packages that use Digester

Package	Description
org.apache.commons.digester	The xmlrules package provides for XML-based definition of rules for Digester.
org.apache.commons.digester.annotations	The annotations package provides for Java5 Annotations meta data-based definition of rules for Digester.
org.apache.commons.digester.plugins	The plugins package provides an easy mechanism whereby new digestion rules can be added dynamically during a digestion.
org.apache.commons.digester.plugins.strategies	The plugins.strategies package contains "rule-finding" strategy classes, and their associated "helper" loader classes.
org.apache.commons.digester.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 Digester in org.apache.commons.digester

Fields in org.apache.commons.digester declared as Digester

Modifier and Type	Field	Description
protected Digester	AbstractObjectCreationFactory.digester	The associated Digester instance that was set up by FactoryCreateRule upon initialization.
protected 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 Digester

Modifier and Type	Method	Description
Digester	AbstractObjectCreationFactory.getDigester()	Returns the Digester that was set by the FactoryCreateRule upon initialization.
Digester	AbstractRulesImpl.getDigester()	Return the Digester instance with which this Rules instance is associated.
Digester	ObjectCreationFactory.getDigester()	Returns the Digester that was set by the FactoryCreateRule upon initialization.
Digester	Rule.getDigester()	Return the Digester with which this Rule is associated.
Digester	Rules.getDigester()	Return the Digester instance with which this Rules instance is associated.
Digester	RulesBase.getDigester()	Return the Digester instance with which this Rules instance is associated.
Digester	WithDefaultsRulesWrapper.getDigester()	Gets digester using these Rules

Methods in org.apache.commons.digester with parameters of type Digester

Modifier and Type	Method	Description
void	RuleSet.addRuleInstances(Digester digester)	Add the set of Rule instances defined in this RuleSet to the specified Digester 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 specified Digester instance, associating them with our namespace URI (if any).
java.lang.Object	StackAction.onPop(Digester d, java.lang.String stackName, java.lang.Object o)	Invoked just after an object has been popped from a digester stack.
java.lang.Object	StackAction.onPush(Digester d, java.lang.String stackName, java.lang.Object o)	Invoked just before an object is to be pushed onto a digester stack.
void	AbstractObjectCreationFactory.setDigester(Digester digester)	Set the Digester 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 the Digester to allow the implementation to do logging, classloading based on the digester's classloader, etc.
void	Rule.setDigester(Digester digester)	Set the Digester with which this Rule 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.setDigester(Digester digester)	Invoked when rule is added to digester.
void	WithDefaultsRulesWrapper.setDigester(Digester digester)	Sets digeseter using these Rules

Constructors in org.apache.commons.digester with parameters of type Digester

Constructor	Description
BeanPropertySetterRule(Digester digester)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
BeanPropertySetterRule(Digester digester, java.lang.String propertyName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
CallMethodRule(Digester digester, java.lang.String methodName, int paramCount)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
CallMethodRule(Digester digester, java.lang.String methodName, int paramCount, java.lang.Class<?>[] paramTypes)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
CallMethodRule(Digester digester, java.lang.String methodName, int paramCount, java.lang.String[] paramTypes)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
CallParamRule(Digester digester, int paramIndex)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
CallParamRule(Digester digester, int paramIndex, java.lang.String attributeName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
FactoryCreateRule(Digester digester, java.lang.Class<?> clazz)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
FactoryCreateRule(Digester digester, java.lang.Class<?> clazz, java.lang.String attributeName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
FactoryCreateRule(Digester digester, java.lang.String className)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
FactoryCreateRule(Digester digester, java.lang.String className, java.lang.String attributeName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
FactoryCreateRule(Digester digester, ObjectCreationFactory creationFactory)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
ObjectCreateRule(Digester digester, java.lang.Class<?> clazz)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
ObjectCreateRule(Digester digester, java.lang.String className)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
ObjectCreateRule(Digester digester, java.lang.String attributeName, java.lang.Class<?> clazz)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
ObjectCreateRule(Digester digester, java.lang.String className, java.lang.String attributeName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
Rule(Digester digester)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetNextRule(Digester digester, java.lang.String methodName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetNextRule(Digester digester, java.lang.String methodName, java.lang.String paramType)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetPropertiesRule(Digester digester)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetPropertyRule(Digester digester, java.lang.String name, java.lang.String value)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetRootRule(Digester digester, java.lang.String methodName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetRootRule(Digester digester, java.lang.String methodName, java.lang.String paramType)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetTopRule(Digester digester, java.lang.String methodName)	Deprecated. The digester instance is now set in the addRule(java.lang.String, org.apache.commons.digester.Rule) method.
SetTopRule(Digester digester, java.lang.String methodName, java.lang.String paramType)	Deprecated. The digester instance is now set in the addRule(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 Digester

Modifier and Type	Method	Description
Digester	DigesterLoader.createDigester(java.lang.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 Digester

Modifier and Type	Method	Description
void	FromAnnotationsRuleSet.addRuleInstances(Digester digester)	Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
void	DigesterLoader.addRules(java.lang.Class<?> target, Digester digester)	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 Digester

Modifier and Type	Field	Description
protected Digester	PluginRules.digester	The Digester instance with which this Rules instance is associated.

Methods in org.apache.commons.digester.plugins that return Digester

Modifier and Type	Method	Description
Digester	PluginRules.getDigester()	Return the Digester instance with which this instance is associated.

Methods in org.apache.commons.digester.plugins with parameters of type Digester

Modifier and Type	Method	Description
abstract void	RuleLoader.addRules(Digester d, java.lang.String path)	Configures the digester with custom rules for some plugged-in class.
void	Declaration.configure(Digester digester, java.lang.String pattern)	Attempt to load custom rules for the target class at the specified pattern.
static void	PluginDeclarationRule.declarePlugin(Digester digester, java.util.Properties props)
RuleLoader	PluginManager.findLoader(Digester digester, java.lang.String id, java.lang.Class<?> pluginClass, java.util.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, java.lang.Class<?> pluginClass, java.util.Properties p)	Apply the finder algorithm to attempt to locate a source of digester rules for the specified plugin class.
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	RulesFactory.newRules(Digester d, java.lang.Class<?> pluginClass)	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.

Uses of Digester in org.apache.commons.digester.plugins.strategies

Methods in org.apache.commons.digester.plugins.strategies with parameters of type Digester

Modifier and Type	Method	Description
void	LoaderFromClass.addRules(Digester d, java.lang.String path)	Just invoke the target method.
void	LoaderFromStream.addRules(Digester d, java.lang.String path)	Add the rules previously loaded from the input stream into the specified digester.
void	LoaderSetProperties.addRules(Digester digester, java.lang.String path)	Just add a SetPropertiesRule at the specified path.
RuleLoader	FinderFromClass.findLoader(Digester digester, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderFromDfltClass.findLoader(Digester digester, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderFromDfltMethod.findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderFromDfltResource.findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderFromFile.findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderFromMethod.findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderFromResource.findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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.
RuleLoader	FinderSetProperties.findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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, java.lang.Class<?> pluginClass, java.io.InputStream is, java.lang.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 Digester

Modifier and Type	Field	Description
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 Digester

Modifier and Type	Method	Description
static Digester	DigesterLoader.createDigester(java.net.URL rulesXml)	Creates a new digester and initializes it from the specified XML file
static Digester	DigesterLoader.createDigester(java.net.URL rulesXml, Digester rulesDigester)	Creates a new digester and initializes it from the specified XML file.
static Digester	DigesterLoader.createDigester(org.xml.sax.InputSource rulesSource)	Creates a new digester and initializes it from the specified InputSource
static Digester	DigesterLoader.createDigester(org.xml.sax.InputSource rulesSource, Digester rulesDigester)	Creates a new digester and initializes it from the specified InputSource.

Methods in org.apache.commons.digester.xmlrules with parameters of type Digester

Modifier and Type	Method	Description
void	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, java.lang.String basePath)	Adds to the digester the set of Rule instances defined in the XML file for this rule set.
static Digester	DigesterLoader.createDigester(java.net.URL rulesXml, Digester rulesDigester)	Creates a new digester and initializes it from the specified XML file.
static Digester	DigesterLoader.createDigester(org.xml.sax.InputSource rulesSource, Digester rulesDigester)	Creates a new digester and initializes it from the specified InputSource.
void	DigesterRulesSource.getRules(Digester digester)	Creates and adds Digester Rules to a given Rules object
void	DigesterRuleParser.setTarget(Digester d)	Sets the digester into which to add the parsed rules

Constructors in org.apache.commons.digester.xmlrules with parameters of type Digester

Constructor	Description
DigesterRuleParser(Digester targetDigester)	Constructs a rule set for converting XML digester rule descriptions into Rule objects, and adding them to the given Digester
FromXmlRuleSet(java.net.URL rulesXml, Digester rulesDigester)	Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.
FromXmlRuleSet(java.net.URL rulesXml, DigesterRuleParser parser, Digester rulesDigester)
FromXmlRuleSet(org.xml.sax.InputSource inputSource, Digester rulesDigester)	Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.
FromXmlRuleSet(org.xml.sax.InputSource inputSource, DigesterRuleParser parser, Digester rulesDigester)