Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractObjectCreationFactory - Class in org.apache.commons.digester
-
Abstract base class for
ObjectCreationFactory
implementations. - AbstractObjectCreationFactory() - Constructor for class org.apache.commons.digester.AbstractObjectCreationFactory
- AbstractRulesImpl - Class in org.apache.commons.digester
-
AbstractRuleImpl
provides basic services forRules
implementations. - AbstractRulesImpl() - Constructor for class org.apache.commons.digester.AbstractRulesImpl
- add(String, Rule) - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Registers a new Rule instance matching the specified pattern.
- add(String, Rule) - Method in class org.apache.commons.digester.ExtendedBaseRules
-
Register a new Rule instance matching the specified pattern.
- add(String, Rule) - Method in class org.apache.commons.digester.plugins.PluginRules
-
Register a new Rule instance matching the specified pattern.
- add(String, Rule) - Method in interface org.apache.commons.digester.Rules
-
Register a new Rule instance matching the specified pattern.
- add(String, Rule) - Method in class org.apache.commons.digester.RulesBase
-
Register a new Rule instance matching the specified pattern.
- add(String, Rule) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- add(String, Rule) - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Adds a Rule to be fired on given pattern.
- add(String, Rule) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
Register a new Rule instance matching a pattern which is constructed by concatenating the pattern prefix with the given pattern.
- add(Rule) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Adds a rule the the target digester.
- addAlias(String, String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
Add an additional custom xml-element -> property mapping.
- addAlias(String, String) - Method in class org.apache.commons.digester.SetPropertiesRule
-
Add an additional attribute name to property name mapping.
- addAlias(SetProperty, Field) - Method in class org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider
-
Adds a new alias attribute/property name; if the attribute name is not specified, the alias will be considered as property name identity.
- addBeanPropertySetter(String) - Method in class org.apache.commons.digester.Digester
-
Add a "bean property setter" rule for the specified parameters.
- addBeanPropertySetter(String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "bean property setter" rule for the specified parameters.
- addCallMethod(String, String) - Method in class org.apache.commons.digester.Digester
-
Add an "call method" rule for a method which accepts no arguments.
- addCallMethod(String, String, int) - Method in class org.apache.commons.digester.Digester
-
Add an "call method" rule for the specified parameters.
- addCallMethod(String, String, int, Class<?>[]) - Method in class org.apache.commons.digester.Digester
-
Add an "call method" rule for the specified parameters.
- addCallMethod(String, String, int, String[]) - Method in class org.apache.commons.digester.Digester
-
Add an "call method" rule for the specified parameters.
- addCallParam(String, int) - Method in class org.apache.commons.digester.Digester
-
Add a "call parameter" rule for the specified parameters.
- addCallParam(String, int, boolean) - Method in class org.apache.commons.digester.Digester
-
Add a "call parameter" rule.
- addCallParam(String, int, int) - Method in class org.apache.commons.digester.Digester
-
Add a "call parameter" rule that sets a parameter from the stack.
- addCallParam(String, int, String) - Method in class org.apache.commons.digester.Digester
-
Add a "call parameter" rule for the specified parameters.
- addCallParamPath(String, int) - Method in class org.apache.commons.digester.Digester
-
Add a "call parameter" rule that sets a parameter from the current
Digester
matching path. - addDeclaration(Declaration) - Method in class org.apache.commons.digester.plugins.PluginManager
-
Add the declaration to the set of known declarations.
- addDefault(Rule) - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Adds a rule to be fired when wrapped implementation returns no matches
- addFactoryCreate(String, Class<?>) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, Class<?>, boolean) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, Class<?>, String) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, Class<?>, String, boolean) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, String, boolean) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, String, String, boolean) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, ObjectCreationFactory) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addFactoryCreate(String, ObjectCreationFactory, boolean) - Method in class org.apache.commons.digester.Digester
-
Add a "factory create" rule for the specified parameters.
- addMappedClass(Class<?>) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Remember that this RuleSet is able to build Digester mapping rules for the input type.
- addObjectCreate(String, Class<?>) - Method in class org.apache.commons.digester.Digester
-
Add an "object create" rule for the specified parameters.
- addObjectCreate(String, String) - Method in class org.apache.commons.digester.Digester
-
Add an "object create" rule for the specified parameters.
- addObjectCreate(String, String, Class<?>) - Method in class org.apache.commons.digester.Digester
-
Add an "object create" rule for the specified parameters.
- addObjectCreate(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add an "object create" rule for the specified parameters.
- addObjectParam(String, int, Object) - Method in class org.apache.commons.digester.Digester
-
Add a "call parameter" rule that sets a parameter from a caller-provided object.
- addRule(String, Rule) - Method in class org.apache.commons.digester.Digester
-
Register a new Rule matching the specified pattern.
- addRuleInstances(Digester) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Add the set of Rule instances defined in this RuleSet to the specified
Digester
instance, associating them with our namespace URI (if any). - addRuleInstances(Digester) - Method in interface org.apache.commons.digester.RuleSet
-
Add the set of Rule instances defined in this RuleSet to the specified
Digester
instance, associating them with our namespace URI (if any). - addRuleInstances(Digester) - Method in class org.apache.commons.digester.RuleSetBase
-
Add the set of Rule instances defined in this RuleSet to the specified
Digester
instance, associating them with our namespace URI (if any). - addRuleInstances(Digester) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Add to the given digester the set of Rule instances used to parse an XML document defining Digester rules.
- addRuleInstances(Digester) - Method in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Adds to the digester the set of Rule instances defined in the XML file for this rule set.
- addRuleInstances(Digester, String) - Method in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Adds to the digester the set of Rule instances defined in the XML file for this rule set.
- addRuleProvider(String, Class<T>, A, E) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Builds and register an
AnnotationRuleProvider
for a specific pattern. - addRuleProvider(String, AnnotationRuleProvider<? extends Annotation, ? extends AnnotatedElement, ? extends Rule>) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Register an
AnnotationRuleProvider
for a specific pattern. - addRules(Class<?>) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Analyzes the target class and adds the
AnnotationRuleProvider
s to thisFromAnnotationsRuleSet
. - addRules(Class<?>, Digester) - Method in class org.apache.commons.digester.annotations.DigesterLoader
-
Add rules to an already created Digester instance, analyzing the digester annotations in the target class.
- addRules(Digester, String) - Method in class org.apache.commons.digester.plugins.RuleLoader
-
Configures the digester with custom rules for some plugged-in class.
- addRules(Digester, String) - Method in class org.apache.commons.digester.plugins.strategies.LoaderFromClass
-
Just invoke the target method.
- addRules(Digester, String) - Method in class org.apache.commons.digester.plugins.strategies.LoaderFromStream
-
Add the rules previously loaded from the input stream into the specified digester.
- addRules(Digester, String) - Method in class org.apache.commons.digester.plugins.strategies.LoaderSetProperties
-
Just add a SetPropertiesRule at the specified path.
- addRuleSet(RuleSet) - Method in class org.apache.commons.digester.Digester
-
Register a set of Rule instances defined in a RuleSet.
- addRulesProviderFrom(FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Add created
AnnotationRuleProvider
s created in another analysis session. - addRulesTo(Class<?>, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.DigesterLoader
-
Analyzes the target class and adds the
AnnotationRuleProvider
s to the existingFromAnnotationsRuleSet
. - addSetNestedProperties(String) - Method in class org.apache.commons.digester.Digester
-
Adds an
SetNestedPropertiesRule
. - addSetNestedProperties(String, String[], String[]) - Method in class org.apache.commons.digester.Digester
-
Adds an
SetNestedPropertiesRule
. - addSetNestedProperties(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Adds an
SetNestedPropertiesRule
. - addSetNext(String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "set next" rule for the specified parameters.
- addSetNext(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "set next" rule for the specified parameters.
- addSetProperties(String) - Method in class org.apache.commons.digester.Digester
-
Add a "set properties" rule for the specified parameters.
- addSetProperties(String, String[], String[]) - Method in class org.apache.commons.digester.Digester
-
Add a "set properties" rule with overridden parameters.
- addSetProperties(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "set properties" rule with a single overridden parameter.
- addSetProperty(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "set property" rule for the specified parameters.
- addSetRoot(String, String) - Method in class org.apache.commons.digester.Digester
-
Add
SetRootRule
with the specified parameters. - addSetRoot(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add
SetRootRule
with the specified parameters. - addSetTop(String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "set top" rule for the specified parameters.
- addSetTop(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Add a "set top" rule for the specified parameters.
- addSource(String, Map<String, Object>) - Method in class org.apache.commons.digester.substitution.MultiVariableExpander
- addTextIfPresent() - Method in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Appends a
Text
node to the current node if the content reported by the parser is not purely whitespace. - aliases - Variable in class org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider
-
The data structure that stores the aliases.
- allowUnknownChildElements - Variable in class org.apache.commons.digester.SetNestedPropertiesRule
- allRules - Variable in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
All rules (preserves order in which they were originally added)
- AnnotationRuleProvider<A extends Annotation,
E extends AnnotatedElement, R extends Rule> - Interface in org.apache.commons.digester.annotations -
An object capable of providing instances of
Rule
. - annotationRuleProviderFactory - Variable in class org.apache.commons.digester.annotations.DigesterLoader
- annotationRuleProviderFactory - Variable in class org.apache.commons.digester.annotations.FromAnnotationRuleProviderFactory
-
The
AnnotationRuleProviderFactory
selected in the previous chained builder. - AnnotationRuleProviderFactory - Interface in org.apache.commons.digester.annotations.spi
-
An object capable of providing instances of
AnnotationRuleProvider
. - annotations - Variable in class org.apache.commons.digester.annotations.reflect.MethodArgument
-
The method argument annotations.
- AnnotationUtils - Class in org.apache.commons.digester.annotations.utils
-
Simple utility class to introspect annotations.
- AnnotationUtils() - Constructor for class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
This class can't be instantiated.
- AnyChildRule() - Constructor for class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRule
- AnyChildRules(SetNestedPropertiesRule.AnyChildRule) - Constructor for class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- attribute - Variable in class org.apache.commons.digester.annotations.providers.AttributeCallParamRuleProvider
- attribute() - Element in annotation type org.apache.commons.digester.annotations.rules.AttributeCallParam
-
Attribute whose value is used as the parameter value.
- AttributeCallParam - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods arguments annotated with
AttributeCallParam
will be bound withCallParamRule
digester rule. - AttributeCallParam.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@AttributeCallParam
annotations on the same element. - AttributeCallParamRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
CallParamRule
. - AttributeCallParamRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.AttributeCallParamRuleProvider
- attributeName - Variable in class org.apache.commons.digester.CallParamRule
-
The attribute from which to save the parameter value
- attributeName - Variable in class org.apache.commons.digester.FactoryCreateRule
-
The attribute containing an override class name if it is present.
- attributeName - Variable in class org.apache.commons.digester.ObjectCreateRule
-
The attribute containing an override class name if it is present.
- attributeName - Variable in class org.apache.commons.digester.ObjectParamRule
-
The attribute which we are attempting to match
- attributeName() - Element in annotation type org.apache.commons.digester.annotations.rules.SetProperty
-
The overridden parameter.
- attributeNames - Variable in class org.apache.commons.digester.SetPropertiesRule
-
Attribute names used to override natural attribute->property mapping
- attributesExpander - Variable in class org.apache.commons.digester.substitution.VariableSubstitutor
-
The expander to be used to expand variables in the attributes.
- attrName - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternRule
- attrs - Variable in class org.apache.commons.digester.substitution.VariableAttributes
B
- baseClass - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
-
A base class that any plugin must derive from.
- baseLog - Static variable in class org.apache.commons.digester.SimpleRegexMatcher
-
Default log (class wide)
- basePath - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser
- basicMatch(String, String) - Method in class org.apache.commons.digester.ExtendedBaseRules
-
Standard match.
- BeanPropertySetter - Annotation Type in org.apache.commons.digester.annotations.rules
-
Fields annotated with
BeanPropertySetter
will be bound withBeanPropertySetterRule
digester rule. - BeanPropertySetter.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@BeanPropertySetter
annotations on the same element. - BeanPropertySetterRule - Class in org.apache.commons.digester
-
Rule implements sets a bean property on the top object to the body text.
- BeanPropertySetterRule() - Constructor for class org.apache.commons.digester.BeanPropertySetterRule
-
Construct rule that automatically sets a property from the body text.
- BeanPropertySetterRule(String) - Constructor for class org.apache.commons.digester.BeanPropertySetterRule
-
Construct rule that sets the given property from the body text.
- BeanPropertySetterRule(Digester) - Constructor for class org.apache.commons.digester.BeanPropertySetterRule
-
Deprecated.
- BeanPropertySetterRule(Digester, String) - Constructor for class org.apache.commons.digester.BeanPropertySetterRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseBeanPropertySetterRule(String propertyName)
instead. - BeanPropertySetterRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.BeanPropertySetterRuleFactory
- BeanPropertySetterRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
BeanPropertySetterRule
. - BeanPropertySetterRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.BeanPropertySetterRuleProvider
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.FactoryCreateRule
-
Process the beginning of this element.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.NodeCreateRule
-
When this method fires, the digester is told to forward all SAX ContentHandler events to the builder object, resulting in a DOM being built instead of normal digester rule-handling occurring.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.ObjectParamRule
-
Process the start of this element.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.PathCallParamRule
-
Process the start of this element.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Invoked when the Digester matches this rule against an xml element.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.plugins.PluginDeclarationRule
-
Invoked upon reading a tag defining a plugin declaration.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.Rule
-
This method is called when the beginning of a matching XML element is encountered.
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRule
- begin(String, String, Attributes) - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
Process the beginning of this element.
- begin(Attributes) - Method in class org.apache.commons.digester.CallMethodRule
-
Process the start of this element.
- begin(Attributes) - Method in class org.apache.commons.digester.CallParamRule
-
Process the start of this element.
- begin(Attributes) - Method in class org.apache.commons.digester.ObjectCreateRule
-
Process the beginning of this element.
- begin(Attributes) - Method in class org.apache.commons.digester.Rule
-
Deprecated.
- begin(Attributes) - Method in class org.apache.commons.digester.SetPropertiesRule
-
Process the beginning of this element.
- begin(Attributes) - Method in class org.apache.commons.digester.SetPropertyRule
-
Process the beginning of this element.
- begin(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.IncludeRule
-
To include a rules xml file, we instantiate another Digester, and another DigesterRulesRuleSet.
- begin(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternRule
-
If a pattern is defined for the attribute, push it onto the pattern stack.
- begin(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetNestedPropertiesAliasRule
-
Add the alias to the SetNestedPropertiesRule object created by the enclosing <set-nested-properties-rule> tag.
- begin(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetPropertiesAliasRule
-
Add the alias to the SetPropertiesRule object created by the enclosing <set-properties-rule> tag.
- body(String) - Method in class org.apache.commons.digester.CallMethodRule
-
Process the body text of this element.
- body(String) - Method in class org.apache.commons.digester.CallParamRule
-
Process the body text of this element.
- body(String) - Method in class org.apache.commons.digester.Rule
-
Deprecated.
- body(String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRule
- body(String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
This is only invoked after all child elements have been processed, so we can remove the custom Rules object that does the child-element-matching.
- body(String, String, String) - Method in class org.apache.commons.digester.BeanPropertySetterRule
-
Process the body text of this element.
- body(String, String, String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Process the body text of this element.
- body(String, String, String) - Method in class org.apache.commons.digester.Rule
-
This method is called when the body of a matching XML element is encountered.
- bodyText - Variable in class org.apache.commons.digester.BeanPropertySetterRule
-
The body text used to set the property.
- bodyText - Variable in class org.apache.commons.digester.CallMethodRule
-
The body text collected from this element.
- bodyText - Variable in class org.apache.commons.digester.Digester
-
The body text of the current element.
- bodyTextExpander - Variable in class org.apache.commons.digester.substitution.VariableSubstitutor
-
The expander to be used to expand variables in the body text.
- bodyTexts - Variable in class org.apache.commons.digester.Digester
-
The stack of body text string buffers for surrounding elements.
- bodyTextStack - Variable in class org.apache.commons.digester.CallParamRule
-
Stack is used to allow nested body text to be processed.
- byDefaultFactories() - Static method in class org.apache.commons.digester.annotations.DigesterLoaderBuilder
-
Builds a new
DigesterLoader
using the default SPI implementations.
C
- cache - Variable in class org.apache.commons.digester.RulesBase
-
The set of registered Rule instances, keyed by the matching pattern.
- cachedRuleSet - Variable in class org.apache.commons.digester.annotations.DigesterLoader
-
In-memory LRU cache that stores already analyzed classes and relative
RuleSet
. - cacheSize - Variable in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
The fixed cache size.
- CallMethod - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods annotated with
CallMethod
will be bound withCallMethodRule
digester rule. - CallMethod.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@CallMethod
annotations on the same element. - CallMethodRule - Class in org.apache.commons.digester
-
Rule implementation that calls a method on an object on the stack (normally the top/parent object), passing arguments collected from subsequent
CallParamRule
rules or from the body of this element. - CallMethodRule(int, String) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name.
- CallMethodRule(int, String, int) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name.
- CallMethodRule(int, String, int, Class<?>[]) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name and parameter types.
- CallMethodRule(int, String, int, String[]) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name and parameter types.
- CallMethodRule(String) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name.
- CallMethodRule(String, int) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name.
- CallMethodRule(String, int, Class<?>[]) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name and parameter types.
- CallMethodRule(String, int, String[]) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Construct a "call method" rule with the specified method name and parameter types.
- CallMethodRule(Digester, String, int) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseCallMethodRule(String methodName,int paramCount)
instead. - CallMethodRule(Digester, String, int, Class<?>[]) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseCallMethodRule(String methodName,int paramCount, Class [] paramTypes)
instead. - CallMethodRule(Digester, String, int, String[]) - Constructor for class org.apache.commons.digester.CallMethodRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseCallMethodRule(String methodName,int paramCount, String [] paramTypes)
instead. - CallMethodRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.CallMethodRuleFactory
- CallMethodRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
CallMethodRule
- CallMethodRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.CallMethodRuleProvider
- CallParam - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods arguments annotated with
CallParam
will be bound withCallParamRule
digester rule. - CallParam.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@CallParam
annotations on the same element. - CallParamRule - Class in org.apache.commons.digester
-
Rule implementation that saves a parameter for use by a surrounding
CallMethodRule
.
- CallParamRule(int) - Constructor for class org.apache.commons.digester.CallParamRule
-
Construct a "call parameter" rule that will save the body text of this element as the parameter value.
- CallParamRule(int, boolean) - Constructor for class org.apache.commons.digester.CallParamRule
-
Construct a "call parameter" rule.
- CallParamRule(int, int) - Constructor for class org.apache.commons.digester.CallParamRule
-
Constructs a "call parameter" rule which sets a parameter from the stack.
- CallParamRule(int, String) - Constructor for class org.apache.commons.digester.CallParamRule
-
Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
- CallParamRule(Digester, int) - Constructor for class org.apache.commons.digester.CallParamRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseCallParamRule(int paramIndex)
instead. - CallParamRule(Digester, int, String) - Constructor for class org.apache.commons.digester.CallParamRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseCallParamRule(int paramIndex, String attributeName)
instead. - CallParamRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.CallParamRuleFactory
- CallParamRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
CallParamRule
. - CallParamRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.CallParamRuleProvider
- capacity - Variable in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
The fixed cache capacity.
- cause - Variable in exception org.apache.commons.digester.plugins.PluginAssertionFailure
- cause - Variable in exception org.apache.commons.digester.plugins.PluginConfigurationException
- cause - Variable in exception org.apache.commons.digester.plugins.PluginException
- cause - Variable in exception org.apache.commons.digester.plugins.PluginInvalidInputException
- cause - Variable in exception org.apache.commons.digester.xmlrules.DigesterLoadingException
- cause - Variable in exception org.apache.commons.digester.xmlrules.XmlLoadException
- characters(char[], int, int) - Method in class org.apache.commons.digester.Digester
-
Process notification of character data received from the body of an XML element.
- characters(char[], int, int) - Method in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Handle notification about text embedded within the current node.
- checkKey(Class<?>) - Static method in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
Verify that a key is not null.
- CircularIncludeException - Exception in org.apache.commons.digester.xmlrules
-
Thrown when parsing XML into Digester rules, if a circular inclusion occurred in the xml digester rules files.
- CircularIncludeException(String) - Constructor for exception org.apache.commons.digester.xmlrules.CircularIncludeException
- classLoader - Variable in class org.apache.commons.digester.Digester
-
The class loader to use for instantiating application objects.
- className - Variable in class org.apache.commons.digester.FactoryCreateRule
-
The Java class name of the ObjectCreationFactory to be created.
- className - Variable in class org.apache.commons.digester.ObjectCreateRule
-
The Java class name of the object to be created.
- clazz - Variable in class org.apache.commons.digester.annotations.providers.ObjectCreateRuleProvider
- cleanup() - Method in class org.apache.commons.digester.Digester
-
Clean up allocated resources after parsing is complete.
- clear() - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Clear all existing Rule instance registrations.
- clear() - Method in class org.apache.commons.digester.Digester
-
Clear the current contents of the default object stack, the param stack, all named stacks, and other internal variables.
- clear() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Clear all rules.
- clear() - Method in class org.apache.commons.digester.RegexRules
-
Clear all existing Rule instance registrations.
- clear() - Method in interface org.apache.commons.digester.Rules
-
Clear all existing Rule instance registrations.
- clear() - Method in class org.apache.commons.digester.RulesBase
-
Clear all existing Rule instance registrations.
- clear() - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- clear() - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Clears all Rule's
- clear() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- configure() - Method in class org.apache.commons.digester.Digester
-
Provide a hook for lazy configuration of this
Digester
instance. - configure(Digester, String) - Method in class org.apache.commons.digester.plugins.Declaration
-
Attempt to load custom rules for the target class at the specified pattern.
- configured - Variable in class org.apache.commons.digester.Digester
-
Has this Digester been configured yet.
- configureOldXerces(SAXParser, Properties) - Static method in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.Configure schema validation as recommended by the JAXP 1.2 spec.
- configureXerces(SAXParserFactory) - Static method in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.Configure schema validation as recommended by the Xerces spec.
- containsKey(Class<?>) - Method in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
Returns true if this cache contains a mapping for the specified key.
- counter - Variable in class org.apache.commons.digester.ExtendedBaseRules
-
Counts the entry number for the rules.
- createDigester(Class<?>) - Method in class org.apache.commons.digester.annotations.DigesterLoader
-
Creates a new digester which rules are defined by analyzing the digester annotations in the target class.
- createDigester(URL) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Creates a new digester and initializes it from the specified XML file
- createDigester(URL, Digester) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Creates a new digester and initializes it from the specified XML file.
- createDigester(InputSource) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Creates a new digester and initializes it from the specified InputSource
- createDigester(InputSource, Digester) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Creates a new digester and initializes it from the specified InputSource.
- createInputSourceFromURL(String) - Method in class org.apache.commons.digester.Digester
-
Convenience method that creates an
InputSource
from the string version of a URL. - createInputSourceFromURL(URL) - Method in class org.apache.commons.digester.Digester
-
Given a URL, return an InputSource that reads from that URL.
- createObject(Attributes) - Method in class org.apache.commons.digester.AbstractObjectCreationFactory
-
Factory method called by
FactoryCreateRule
to supply an object based on the element's attributes. - createObject(Attributes) - Method in interface org.apache.commons.digester.ObjectCreationFactory
-
Factory method called by
FactoryCreateRule
to supply an object based on the element's attributes. - createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.BeanPropertySetterRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.CallMethodRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.CallParamRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.FactoryCreateRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.NodeCreateRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.ObjectCreateRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.ObjectParamRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetNestedPropertiesRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetNextRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetPropertiesRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetPropertyRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetRootRuleFactory
- createObject(Attributes) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetTopRuleFactory
- createSAXException(Exception) - Method in class org.apache.commons.digester.Digester
-
Create a SAX exception which also understands about the location in the digester file where the exception occurs
- createSAXException(String) - Method in class org.apache.commons.digester.Digester
-
Create a SAX exception which also understands about the location in the digester file where the exception occurs
- createSAXException(String, Exception) - Method in class org.apache.commons.digester.Digester
-
Create a SAX exception which also understands about the location in the digester file where the exception occurs
- creationFactory - Variable in class org.apache.commons.digester.FactoryCreateRule
-
The object creation factory we will use to instantiate objects as required based on the attributes specified in the matched XML element.
- CreationRule - Annotation Type in org.apache.commons.digester.annotations
-
Marks a Digester rule as a creation rule, that's crucial for the
setNext
rule. - currChildElementName - Variable in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRule
- currChildNamespaceURI - Variable in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRule
- customContentHandler - Variable in class org.apache.commons.digester.Digester
-
If not null, then calls by the parser to this object's characters, startElement, endElement and processingInstruction methods are forwarded to the specified object.
D
- data - Variable in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
The map that implements the LRU cache.
- Declaration - Class in org.apache.commons.digester.plugins
-
Represents a Class that can be instantiated by a PluginCreateRule, plus info on how to load custom digester rules for mapping xml into that plugged-in class.
- Declaration(Class<?>) - Constructor for class org.apache.commons.digester.plugins.Declaration
-
Constructor.
- Declaration(Class<?>, RuleLoader) - Constructor for class org.apache.commons.digester.plugins.Declaration
-
Create an instance where a fully-initialised ruleLoader instance is provided by the caller instead of having the PluginManager "discover" an appropriate one.
- Declaration(String) - Constructor for class org.apache.commons.digester.plugins.Declaration
-
Constructor.
- declarationsByClass - Variable in class org.apache.commons.digester.plugins.PluginManager
-
Map of classname->Declaration
- declarationsById - Variable in class org.apache.commons.digester.plugins.PluginManager
-
Map of id->Declaration
- declarePlugin(Digester, Properties) - Static method in class org.apache.commons.digester.plugins.PluginDeclarationRule
- decoratedRules - Variable in class org.apache.commons.digester.plugins.PluginRules
-
The rules implementation that we are "enhancing" with plugins functionality, as per the Decorator pattern.
- decoratedRules - Variable in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- DefaultAnnotationRuleProviderFactory - Class in org.apache.commons.digester.annotations.internal
-
Default
AnnotationRuleProviderFactory
implementation. - DefaultAnnotationRuleProviderFactory() - Constructor for class org.apache.commons.digester.annotations.internal.DefaultAnnotationRuleProviderFactory
- DefaultDigesterLoaderHandlerFactory - Class in org.apache.commons.digester.annotations.internal
-
Default
DigesterLoaderHandlerFactory
implementation. - DefaultDigesterLoaderHandlerFactory() - Constructor for class org.apache.commons.digester.annotations.internal.DefaultDigesterLoaderHandlerFactory
- DefaultLoaderHandler - Interface in org.apache.commons.digester.annotations.handlers
-
The DefaultLoaderHandler marks rules that have to be processed by the built-in Digester annotation rules engine.
- defaultPlugin - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
-
Info about optional default plugin to be used if no plugin-id is specified in the input data.
- defaultRules - Variable in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Rules to be fired when the wrapped implementations returns none.
- delegate - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
- depth - Variable in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Depth of the current node, relative to the element where the content handler was put into action.
- DFLT_FALSEVAL - Static variable in class org.apache.commons.digester.plugins.strategies.FinderSetProperties
- DFLT_FILENAME_ATTR - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromFile
-
Xml attribute that needs to be present on a plugin declaration in order to specify the file to load rules from.
- DFLT_METHOD_ATTR - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromClass
- DFLT_METHOD_ATTR - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromMethod
-
Xml attribute that needs to be present on a plugin declaration in order to specify the method to load rules from.
- DFLT_METHOD_NAME - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromClass
- DFLT_METHOD_NAME - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
- DFLT_METHOD_NAME - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltMethod
- DFLT_PLUGIN_CLASS_ATTR - Variable in class org.apache.commons.digester.plugins.PluginContext
- DFLT_PLUGIN_CLASS_ATTR_NS - Variable in class org.apache.commons.digester.plugins.PluginContext
- DFLT_PLUGIN_ID_ATTR - Variable in class org.apache.commons.digester.plugins.PluginContext
- DFLT_PLUGIN_ID_ATTR_NS - Variable in class org.apache.commons.digester.plugins.PluginContext
- DFLT_PROPS_ATTR - Static variable in class org.apache.commons.digester.plugins.strategies.FinderSetProperties
- DFLT_RESOURCE_ATTR - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromResource
-
Name of xml attribute on the plugin declaration which is used to configure rule-loading for that declaration.
- DFLT_RESOURCE_SUFFIX - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltResource
- DFLT_RULECLASS_ATTR - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromClass
- DFLT_RULECLASS_SUFFIX - Static variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
- dfltMethodName - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromClass
- digester - Variable in class org.apache.commons.digester.AbstractObjectCreationFactory
-
The associated
Digester
instance that was set up byFactoryCreateRule
upon initialization. - digester - Variable in class org.apache.commons.digester.AbstractRulesImpl
-
Digester using this
Rules
implementation - digester - Variable in class org.apache.commons.digester.plugins.PluginRules
-
The Digester instance with which this Rules instance is associated.
- digester - Variable in class org.apache.commons.digester.Rule
-
The Digester with which this Rule is associated.
- digester - Variable in class org.apache.commons.digester.RulesBase
-
The Digester instance with which this Rules instance is associated.
- Digester - Class in org.apache.commons.digester
-
A Digester processes an XML input stream by matching a series of element nesting patterns to execute Rules that have been added prior to the start of parsing.
- Digester() - Constructor for class org.apache.commons.digester.Digester
-
Construct a new Digester with default properties.
- Digester(SAXParser) - Constructor for class org.apache.commons.digester.Digester
-
Construct a new Digester, allowing a SAXParser to be passed in.
- Digester(XMLReader) - Constructor for class org.apache.commons.digester.Digester
-
Construct a new Digester, allowing an XMLReader to be passed in.
- DIGESTER_DTD_PATH - Static variable in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
- DIGESTER_PUBLIC_ID - Static variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser
- digesterDtdUrl - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
path to the DTD
- digesterLoader - Variable in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
- DigesterLoader - Class in org.apache.commons.digester.annotations
-
This class manages the creation of Digester instances analyzing target classes annotated with digester annotations.
- DigesterLoader - Class in org.apache.commons.digester.xmlrules
-
This class manages the creation of Digester instances from XML digester rules files.
- DigesterLoader() - Constructor for class org.apache.commons.digester.xmlrules.DigesterLoader
- DigesterLoader(AnnotationRuleProviderFactory, DigesterLoaderHandlerFactory) - Constructor for class org.apache.commons.digester.annotations.DigesterLoader
-
Creates a new
DigesterLoader
instance. - DigesterLoaderBuilder - Class in org.apache.commons.digester.annotations
-
DigesterLoader
builder implementation. - DigesterLoaderBuilder() - Constructor for class org.apache.commons.digester.annotations.DigesterLoaderBuilder
- DigesterLoaderHandler<A extends Annotation,
E extends AnnotatedElement> - Interface in org.apache.commons.digester.annotations -
A
DigesterLoaderHandler
intercept aClass
visit performed by theDigesterLoader
and performs theDigesterLoaderHandler.handle(Annotation, AnnotatedElement, FromAnnotationsRuleSet)
method. - digesterLoaderHandlerFactory - Variable in class org.apache.commons.digester.annotations.DigesterLoader
- DigesterLoaderHandlerFactory - Interface in org.apache.commons.digester.annotations.spi
-
An object capable of providing instances of
DigesterLoaderHandler
. - DigesterLoadingException - Exception in org.apache.commons.digester.annotations
-
The exception thrown when an error occurs while analyzing targets and building rule sets.
- DigesterLoadingException - Exception in org.apache.commons.digester.xmlrules
-
Thrown when an error occurs while parsing XML into Digester rules.
- DigesterLoadingException(String) - Constructor for exception org.apache.commons.digester.annotations.DigesterLoadingException
-
Constructs a new loading exception with the specified detail message.
- DigesterLoadingException(String) - Constructor for exception org.apache.commons.digester.xmlrules.DigesterLoadingException
- DigesterLoadingException(String, Throwable) - Constructor for exception org.apache.commons.digester.annotations.DigesterLoadingException
-
Constructs a new loading exception with the specified detail message and cause.
- DigesterLoadingException(String, Throwable) - Constructor for exception org.apache.commons.digester.xmlrules.DigesterLoadingException
- DigesterLoadingException(Throwable) - Constructor for exception org.apache.commons.digester.annotations.DigesterLoadingException
-
Constructs a new loading exception with the specified cause.
- DigesterLoadingException(Throwable) - Constructor for exception org.apache.commons.digester.xmlrules.DigesterLoadingException
- DigesterRule - Annotation Type in org.apache.commons.digester.annotations
-
Meta-annotation that marks an annotation as part of commons-digester.
- DigesterRuleList - Annotation Type in org.apache.commons.digester.annotations
-
Meta-annotation that marks an annotation as a list of commons-digester annotations.
- DigesterRuleParser - Class in org.apache.commons.digester.xmlrules
-
This is a RuleSet that parses XML into Digester rules, and then adds those rules to a 'target' Digester.
- DigesterRuleParser() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Constructs a DigesterRuleParser.
- DigesterRuleParser(Digester) - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Constructs a rule set for converting XML digester rule descriptions into Rule objects, and adding them to the given Digester
- DigesterRuleParser(Digester, DigesterRuleParser.PatternStack<String>, Set<String>) - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Constructs a rule set for parsing an XML digester rule file that has been included within an outer XML digester rule file.
- DigesterRuleParser.BeanPropertySetterRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a BeanPropertySetterRule.
- DigesterRuleParser.CallMethodRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a CallMethodRule.
- DigesterRuleParser.CallParamRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a CallParamRule.
- DigesterRuleParser.FactoryCreateRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a FactoryCreateRule
- DigesterRuleParser.IncludeRule - Class in org.apache.commons.digester.xmlrules
-
A rule for including one rules XML file within another.
- DigesterRuleParser.NodeCreateRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a NodeCreateRule
- DigesterRuleParser.ObjectCreateRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a ObjectCreateRule
- DigesterRuleParser.ObjectParamRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a ObjectParamRule
- DigesterRuleParser.PatternRule - Class in org.apache.commons.digester.xmlrules
-
A rule for extracting the pattern matching strings from the rules XML.
- DigesterRuleParser.PatternStack<E> - Class in org.apache.commons.digester.xmlrules
-
A stack whose toString method returns a '/'-separated concatenation of all the elements in the stack.
- DigesterRuleParser.RulesPrefixAdapter - Class in org.apache.commons.digester.xmlrules
-
Wraps a Rules object.
- DigesterRuleParser.SetNestedPropertiesAliasRule - Class in org.apache.commons.digester.xmlrules
-
A rule for adding a attribute-property alias to the custom alias mappings of the containing SetNestedPropertiesRule rule.
- DigesterRuleParser.SetNestedPropertiesRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a SetNestedPropertiesRule
- DigesterRuleParser.SetNextRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a SetNextRuleFactory
- DigesterRuleParser.SetPropertiesAliasRule - Class in org.apache.commons.digester.xmlrules
-
A rule for adding a attribute-property alias to the custom alias mappings of the containing SetPropertiesRule rule.
- DigesterRuleParser.SetPropertiesRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a SetPropertiesRule
- DigesterRuleParser.SetPropertyRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a SetPropertyRule
- DigesterRuleParser.SetRootRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a SetRootRuleFactory
- DigesterRuleParser.SetTopRuleFactory - Class in org.apache.commons.digester.xmlrules
-
Factory for creating a SetTopRuleFactory
- DigesterRulesSource - Interface in org.apache.commons.digester.xmlrules
-
Interface for classes that initialize a Digester Rules object with Digester Rules.
- doc - Variable in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
A DOM Document used to create the various Node instances.
- documentBuilder - Variable in class org.apache.commons.digester.NodeCreateRule
-
The JAXP
DocumentBuilder
to use. - doHandle(A, Annotation, Method, Class<?>, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.handlers.MethodHandler
- doHandle(Annotation, Method, Class<?>, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.handlers.MethodHandler
E
- elementNames - Variable in class org.apache.commons.digester.SetNestedPropertiesRule
- end() - Method in class org.apache.commons.digester.CallMethodRule
-
Process the end of this element.
- end() - Method in class org.apache.commons.digester.NodeCreateRule
-
Pop the Node off the top of the stack.
- end() - Method in class org.apache.commons.digester.ObjectCreateRule
-
Process the end of this element.
- end() - Method in class org.apache.commons.digester.Rule
-
Deprecated.
- end() - Method in class org.apache.commons.digester.SetNextRule
-
Process the end of this element.
- end() - Method in class org.apache.commons.digester.SetRootRule
-
Process the end of this element.
- end() - Method in class org.apache.commons.digester.SetTopRule
-
Process the end of this element.
- end() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternRule
-
If there was a pattern for this element, pop it off the pattern stack.
- end(String, String) - Method in class org.apache.commons.digester.BeanPropertySetterRule
-
Process the end of this element.
- end(String, String) - Method in class org.apache.commons.digester.CallParamRule
-
Process any body texts now.
- end(String, String) - Method in class org.apache.commons.digester.FactoryCreateRule
-
Process the end of this element.
- end(String, String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Invoked by the digester when the closing tag matching this Rule's pattern is encountered.
- end(String, String) - Method in class org.apache.commons.digester.Rule
-
This method is called when the end of a matching XML element is encountered.
- end(String, String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRule
- endDocument() - Method in class org.apache.commons.digester.Digester
-
Process notification of the end of the document being reached.
- endElement(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Process notification of the end of an XML element being reached.
- endElement(String, String, String) - Method in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Checks whether control needs to be returned to Digester.
- endPrefixMapping(String) - Method in class org.apache.commons.digester.Digester
-
Process notification that a namespace prefix is going out of scope.
- entityResolver - Variable in class org.apache.commons.digester.Digester
-
The EntityResolver used by the SAX parser.
- entityValidator - Variable in class org.apache.commons.digester.Digester
-
The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.
- error(SAXParseException) - Method in class org.apache.commons.digester.Digester
-
Forward notification of a parsing error to the application supplied error handler (if any).
- errorHandler - Variable in class org.apache.commons.digester.Digester
-
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.
- exceptionIgnoredStack - Variable in class org.apache.commons.digester.FactoryCreateRule
-
Stock to manage
- expand(String) - Method in class org.apache.commons.digester.substitution.MultiVariableExpander
- expand(String) - Method in interface org.apache.commons.digester.substitution.VariableExpander
-
Return the input string with any variables replaced by their corresponding value.
- expand(String, String, Map<String, Object>) - Method in class org.apache.commons.digester.substitution.MultiVariableExpander
-
Replace any occurrences within the string of the form "marker{key}" with the value from source[key].
- expander - Variable in class org.apache.commons.digester.substitution.VariableAttributes
- ExtendedBaseRules - Class in org.apache.commons.digester
-
Extension of
RulesBase
for complex schema. - ExtendedBaseRules() - Constructor for class org.apache.commons.digester.ExtendedBaseRules
F
- factory - Variable in class org.apache.commons.digester.Digester
-
The SAXParserFactory that is created the first time we need it.
- factoryClass - Variable in class org.apache.commons.digester.annotations.providers.FactoryCreateRuleProvider
- factoryClass() - Element in annotation type org.apache.commons.digester.annotations.rules.FactoryCreate
-
The Java class of the object creation factory class
- FactoryCreate - Annotation Type in org.apache.commons.digester.annotations.rules
-
Classes annotated with
FactoryCreate
will be bound withFactoryCreateRule
digester rule. - FactoryCreate.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@FactoryCreate
annotations on the same element. - FactoryCreateRule - Class in org.apache.commons.digester
-
Rule implementation that uses an
ObjectCreationFactory
to create a new object which it pushes onto the object stack. - FactoryCreateRule(Class<?>) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class to create an
ObjectCreationFactory
which will then be used to create an object and push it on the stack. - FactoryCreateRule(Class<?>, boolean) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class to create an
ObjectCreationFactory
which will then be used to create an object and push it on the stack. - FactoryCreateRule(Class<?>, String) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class (possibly overridden by the specified attribute if present) to create an
ObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack. - FactoryCreateRule(Class<?>, String, boolean) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class (possibly overridden by the specified attribute if present) to create an
ObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack. - FactoryCreateRule(String) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class name to create an
ObjectCreationFactory
which will then be used to create an object and push it on the stack. - FactoryCreateRule(String, boolean) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class name to create an
ObjectCreationFactory
which will then be used to create an object and push it on the stack. - FactoryCreateRule(String, String) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class name (possibly overridden by the specified attribute if present) to create an
ObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack. - FactoryCreateRule(String, String, boolean) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule that will use the specified class name (possibly overridden by the specified attribute if present) to create an
ObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack. - FactoryCreateRule(Digester, Class<?>) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseFactoryCreateRule(Class clazz)
instead. - FactoryCreateRule(Digester, Class<?>, String) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseFactoryCreateRule(Class clazz, String attributeName)
instead. - FactoryCreateRule(Digester, String) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseFactoryCreateRule(String className)
instead. - FactoryCreateRule(Digester, String, String) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseFactoryCreateRule(String className, String attributeName)
instead. - FactoryCreateRule(Digester, ObjectCreationFactory) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseFactoryCreateRule(ObjectCreationFactory creationFactory)
instead. - FactoryCreateRule(ObjectCreationFactory) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory
. - FactoryCreateRule(ObjectCreationFactory, boolean) - Constructor for class org.apache.commons.digester.FactoryCreateRule
-
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory
. - FactoryCreateRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.FactoryCreateRuleFactory
- FactoryCreateRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
FactoryCreateRule
. - FactoryCreateRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.FactoryCreateRuleProvider
- falseval - Variable in class org.apache.commons.digester.plugins.strategies.FinderSetProperties
- fatalError(SAXParseException) - Method in class org.apache.commons.digester.Digester
-
Forward notification of a fatal parsing error to the application supplied error handler (if any).
- filenameAttr - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromFile
- FinderFromClass - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which expects the caller to specify a classname and methodname as plugin properties.
- FinderFromClass() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromClass
- FinderFromClass(String, String, String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromClass
-
Create a rule-finder which invokes a user-specified method on a user-specified class whenever dynamic rules for a plugin need to be loaded.
- FinderFromDfltClass - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which looks for a method with a specific name on a class whose name is derived from the plugin class name.
- FinderFromDfltClass() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
- FinderFromDfltClass(String, String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
-
Create a rule-finder which invokes a method on a class whenever dynamic rules for a plugin need to be loaded.
- FinderFromDfltMethod - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which looks for a method with a specific name on the plugin class.
- FinderFromDfltMethod() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromDfltMethod
- FinderFromDfltMethod(String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromDfltMethod
-
Create a rule-finder which invokes a specific method on the plugin class whenever dynamic rules for a plugin need to be loaded.
- FinderFromDfltResource - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which looks for a resource file in the classpath whose name is derived from the plugin class name plus a specified suffix.
- FinderFromDfltResource() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromDfltResource
- FinderFromDfltResource(String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromDfltResource
-
Create a rule-finder which can load an xmlrules file, cache the rules away, and later add them as a plugin's custom rules when that plugin is referenced.
- FinderFromFile - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which expects the user to specify an absolute or relative path in the plugin declaration.
- FinderFromFile() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromFile
- FinderFromFile(String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromFile
- FinderFromMethod - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which expects the caller to specify a methodname as a plugin property, where the method exists on the plugin class.
- FinderFromMethod() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromMethod
-
Constructor.
- FinderFromMethod(String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromMethod
- FinderFromResource - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which expects the user to specify a resource name (ie a file in the classpath).
- FinderFromResource() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromResource
-
Constructor.
- FinderFromResource(String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderFromResource
- FinderSetProperties - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which expects the user to specify whether "automatic property setting" is desired.
- FinderSetProperties() - Constructor for class org.apache.commons.digester.plugins.strategies.FinderSetProperties
- FinderSetProperties(String, String) - Constructor for class org.apache.commons.digester.plugins.strategies.FinderSetProperties
-
Create a rule-finder which will arrange for a SetPropertiesRule to be defined for each instance of a plugin, so that xml attributes map to bean properties.
- findExactAncesterMatch(String) - Method in class org.apache.commons.digester.ExtendedBaseRules
-
Finds an exact ancester match for given pattern
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.RuleFinder
-
Apply the finder algorithm to attempt to locate a source of digester rules for the specified plugin class.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromClass
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromDfltMethod
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromDfltResource
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromFile
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromMethod
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderFromResource
-
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.
- findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.strategies.FinderSetProperties
-
Returns a RuleLoader unless the properties contain an entry with the name matching constructor param propsAttr, and the value matching what is in falseval.
- findLoader(Digester, String, Class<?>, Properties) - Method in class org.apache.commons.digester.plugins.PluginManager
-
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).
- findNamespaceURI(String) - Method in class org.apache.commons.digester.Digester
-
Return the currently mapped namespace URI for the specified prefix, if any; otherwise return
null
. - finish() - Method in class org.apache.commons.digester.BeanPropertySetterRule
-
Clean up after parsing is complete.
- finish() - Method in class org.apache.commons.digester.CallMethodRule
-
Clean up after parsing is complete.
- finish() - Method in class org.apache.commons.digester.FactoryCreateRule
-
Clean up after parsing is complete.
- finish() - Method in class org.apache.commons.digester.Rule
-
This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
- fireBeginMethods(List<Rule>, String, String, Attributes) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Duplicate the processing that the Digester does when firing the begin methods of rules.
- fireBodyMethods(List<Rule>, String, String, String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Duplicate the processing that the Digester does when firing the body methods of rules.
- fireEndMethods(List<Rule>, String, String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Duplicate the processing that the Digester does when firing the end methods of rules.
- FromAnnotationRuleProviderFactory - Class in org.apache.commons.digester.annotations
-
DigesterLoader
builder implementation. - FromAnnotationRuleProviderFactory(AnnotationRuleProviderFactory) - Constructor for class org.apache.commons.digester.annotations.FromAnnotationRuleProviderFactory
-
DigesterLoader
builder implementation. - FromAnnotationsRuleSet - Class in org.apache.commons.digester.annotations
- FromAnnotationsRuleSet(DigesterLoader) - Constructor for class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Created a new
FromAnnotationsRuleSet
instance. - fromStack - Variable in class org.apache.commons.digester.CallParamRule
-
Is the parameter to be set from the stack?
- FromXmlRuleSet - Class in org.apache.commons.digester.xmlrules
-
A Digester rule set where the rules come from an XML file.
- FromXmlRuleSet(URL) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.
- FromXmlRuleSet(URL, Digester) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.
- FromXmlRuleSet(URL, DigesterRuleParser) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
- FromXmlRuleSet(URL, DigesterRuleParser, Digester) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
- FromXmlRuleSet(InputSource) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Constructs a FromXmlRuleSet using the default DigesterRuleParser and rulesDigester.
- FromXmlRuleSet(InputSource, Digester) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Constructs a FromXmlRuleSet using the default DigesterRuleParser and a ruleDigester for loading the rules xml.
- FromXmlRuleSet(InputSource, DigesterRuleParser) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
- FromXmlRuleSet(InputSource, DigesterRuleParser, Digester) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet
- FromXmlRuleSet.InputSourceXMLRulesLoader - Class in org.apache.commons.digester.xmlrules
-
Loads XMLRules from an InputSource
- FromXmlRuleSet.URLXMLRulesLoader - Class in org.apache.commons.digester.xmlrules
-
Loads XMLRules from an URL
- FromXmlRuleSet.XMLRulesLoader - Class in org.apache.commons.digester.xmlrules
-
Worker class encapsulates loading mechanisms.
G
- GenericParser - Class in org.apache.commons.digester.parser
-
Deprecated.Create an XMLParser instance yourself, configure validation appropriately, and pass it as a parameter to the
Digester
constructor, or useDigester.setXMLSchema(javax.xml.validation.Schema)
for validation. - GenericParser() - Constructor for class org.apache.commons.digester.parser.GenericParser
-
Deprecated.
- get() - Method in interface org.apache.commons.digester.annotations.AnnotationRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.AttributeCallParamRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.BeanPropertySetterRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.CallMethodRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.CallParamRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.FactoryCreateRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.ObjectCreateRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.PathCallParamRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.SetNextRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.SetRootRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.SetTopRuleProvider
-
Provides an instance of
Rule
. - get() - Method in class org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider
-
Provides an instance of
Rule
. - get(Class<?>) - Method in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
Returns the value to which the specified key is cached, or null if this cache contains no mapping for the key.
- getAllowUnknownChildElements() - Method in class org.apache.commons.digester.SetNestedPropertiesRule
- getAnnotation(Class<T>) - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
- getAnnotationPattern(Annotation) - Static method in class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
Extract the
pattern()
from annotation. - getAnnotationRuleProviderFactory() - Method in class org.apache.commons.digester.annotations.DigesterLoader
- getAnnotations() - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
- getAnnotationsArrayCopy() - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
-
Returns an annotations array, copy of the declared annotations in this method argument.
- getAnnotationsArrayValue(Annotation) - Static method in class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
Extract the Annotations array
value()
from annotation if present, nul otherwise. - getAnnotationValue(Annotation) - Static method in class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
Extract the
value()
from annotation. - getCause() - Method in exception org.apache.commons.digester.plugins.PluginAssertionFailure
-
Return the cause of this exception (if any) as specified in the exception constructor.
- getCause() - Method in exception org.apache.commons.digester.plugins.PluginConfigurationException
-
Return the cause of this exception (if any) as specified in the exception constructor.
- getCause() - Method in exception org.apache.commons.digester.plugins.PluginException
- getCause() - Method in exception org.apache.commons.digester.plugins.PluginInvalidInputException
-
Return the cause of this exception (if any) as specified in the exception constructor.
- getCause() - Method in exception org.apache.commons.digester.xmlrules.DigesterLoadingException
-
Return the cause of this exception (if any) as specified in the exception constructor.
- getCause() - Method in exception org.apache.commons.digester.xmlrules.XmlLoadException
-
Returns the cause of this throwable or null if the cause is nonexistent or unknown.
- getClassLoader() - Method in class org.apache.commons.digester.Digester
-
Return the class loader to be used for instantiating application objects when required.
- getCount() - Method in class org.apache.commons.digester.Digester
-
Return the current depth of the element stack.
- getCurrentElementName() - Method in class org.apache.commons.digester.Digester
-
Return the name of the XML element that is currently being processed.
- getCurrentNamespaces() - Method in class org.apache.commons.digester.Digester
-
Get the most current namespaces for all prefixes.
- getCustomContentHandler() - Method in class org.apache.commons.digester.Digester
- getDebug() - Method in class org.apache.commons.digester.Digester
-
Deprecated.This method now always returns 0. Digester uses the apache jakarta commons-logging library; see the documentation for that library for more information.
- getDeclarationByClass(String) - Method in class org.apache.commons.digester.plugins.PluginManager
-
Return the declaration object with the specified class.
- getDeclarationById(String) - Method in class org.apache.commons.digester.plugins.PluginManager
-
Return the declaration object with the specified id.
- getDeclaredAnnotations() - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
- getDecoratedRules() - Method in class org.apache.commons.digester.plugins.PluginRules
-
This package-scope method is used by the PluginCreateRule class to get direct access to the rules that were dynamically added by the plugin.
- getDefaults() - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Gets Rule's which will be fired when the wrapped implementation returns no matches
- getDigester() - Method in class org.apache.commons.digester.AbstractObjectCreationFactory
-
Returns the
Digester
that was set by theFactoryCreateRule
upon initialization. - getDigester() - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Return the Digester instance with which this Rules instance is associated.
- getDigester() - Method in interface org.apache.commons.digester.ObjectCreationFactory
-
Returns the
Digester
that was set by theFactoryCreateRule
upon initialization. - getDigester() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return the Digester instance with which this instance is associated.
- getDigester() - Method in class org.apache.commons.digester.Rule
-
Return the Digester with which this Rule is associated.
- getDigester() - Method in interface org.apache.commons.digester.Rules
-
Return the Digester instance with which this Rules instance is associated.
- getDigester() - Method in class org.apache.commons.digester.RulesBase
-
Return the Digester instance with which this Rules instance is associated.
- getDigester() - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- getDigester() - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Gets digester using these Rules
- getDigester() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- getDigesterLoaderHandlerFactory() - Method in class org.apache.commons.digester.annotations.DigesterLoader
- getDigesterRulesDTD() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Returns the location of the DTD used to validate the digester rules XML document.
- getDocumentLocator() - Method in class org.apache.commons.digester.Digester
-
Gets the document locator associated with our parser.
- getEntityResolver() - Method in class org.apache.commons.digester.Digester
-
Return the Entity Resolver used by the SAX parser.
- getErrorHandler() - Method in class org.apache.commons.digester.Digester
-
Return the error handler for this Digester.
- getFactory() - Method in class org.apache.commons.digester.Digester
-
Return the SAXParserFactory we will use, creating one if necessary.
- getFactory(Attributes) - Method in class org.apache.commons.digester.FactoryCreateRule
-
Return an instance of our associated object creation factory, creating one if necessary.
- getFeature(String) - Method in class org.apache.commons.digester.Digester
-
Returns a flag indicating whether the requested feature is supported by the underlying implementation of
org.xml.sax.XMLReader
. - getId() - Method in class org.apache.commons.digester.plugins.Declaration
-
Return the id associated with this declaration.
- getIndex() - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
-
Returns the method argument index.
- getIndex(String) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getIndex(String, String) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getLength() - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getLocalName(int) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getLog() - Method in class org.apache.commons.digester.SimpleRegexMatcher
-
Gets the
Log
implementation. - getLogger() - Method in class org.apache.commons.digester.Digester
-
Return the current Logger associated with this instance of the Digester
- getLogger(Digester) - Static method in class org.apache.commons.digester.plugins.LogUtils
-
Get the Log object associated with the specified Digester instance, or a "no-op" logging object if the digester reference is null.
- getMatch() - Method in class org.apache.commons.digester.Digester
-
Return the current rule match path
- getNamespaceAware() - Method in class org.apache.commons.digester.Digester
-
Return the "namespace aware" flag for parsers we create.
- getNamespaceURI() - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Return the namespace URI that will be applied to all subsequently added
Rule
objects. - getNamespaceURI() - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Return the namespace URI that will be applied to all Rule instances created from this RuleSet.
- getNamespaceURI() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return the namespace URI that will be applied to all subsequently added
Rule
objects. - getNamespaceURI() - Method in class org.apache.commons.digester.Rule
-
Return the namespace URI for which this Rule is relevant, if any.
- getNamespaceURI() - Method in interface org.apache.commons.digester.Rules
-
Return the namespace URI that will be applied to all subsequently added
Rule
objects. - getNamespaceURI() - Method in class org.apache.commons.digester.RulesBase
-
Return the namespace URI that will be applied to all subsequently added
Rule
objects. - getNamespaceURI() - Method in interface org.apache.commons.digester.RuleSet
-
Return the namespace URI that will be applied to all Rule instances created from this RuleSet.
- getNamespaceURI() - Method in class org.apache.commons.digester.RuleSetBase
-
Return the namespace URI that will be applied to all Rule instances created from this RuleSet.
- getNamespaceURI() - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- getNamespaceURI() - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Gets namespace to apply to Rule's added
- getNamespaceURI() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- getOldRules() - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- getParameterType() - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
-
Returns the method argument type.
- getParamTypes(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.CallMethodRuleFactory
-
Process the comma separated list of paramTypes into an array of String class names
- getParent() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return the parent Rules object.
- getParser() - Method in class org.apache.commons.digester.Digester
-
Return the SAXParser we will use to parse the input stream.
- getPattern() - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Return the pattern that this Rule is associated with.
- getPluginClass() - Method in class org.apache.commons.digester.plugins.Declaration
-
Return plugin class associated with this declaration.
- getPluginClassAttr() - Method in class org.apache.commons.digester.plugins.PluginContext
-
Get the namespace for the xml attribute which indicates to a PluginCreateRule which class is to be plugged in.
- getPluginClassAttr() - Method in class org.apache.commons.digester.plugins.PluginRules
- getPluginClassAttrNs() - Method in class org.apache.commons.digester.plugins.PluginContext
-
Get the namespace for the xml attribute which indicates to a PluginCreateRule which class is to be plugged in.
- getPluginClassAttrNs() - Method in class org.apache.commons.digester.plugins.PluginRules
- getPluginIdAttr() - Method in class org.apache.commons.digester.plugins.PluginContext
-
Get the namespace for the xml attribute which indicates to a PluginCreateRule which previous plugin declaration should be used.
- getPluginIdAttr() - Method in class org.apache.commons.digester.plugins.PluginRules
- getPluginIdAttrNs() - Method in class org.apache.commons.digester.plugins.PluginContext
-
Get the namespace for the xml attribute which indicates to a PluginCreateRule which previous plugin declaration should be used.
- getPluginIdAttrNs() - Method in class org.apache.commons.digester.plugins.PluginRules
- getPluginManager() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return the object which "knows" about all declared plugins.
- getProperty(String) - Method in class org.apache.commons.digester.Digester
-
Return the current value of the specified property for the underlying
XMLReader
implementation. - getProvider(String, Class<T>) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Retrieves a specific instance of the
AnnotationRuleProvider
for the input pattern. - getPublicId() - Method in class org.apache.commons.digester.Digester
-
Return the public identifier of the DTD we are currently parsing under, if any.
- getQName(int) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getReader() - Method in class org.apache.commons.digester.Digester
-
Deprecated.Use getXMLReader() instead, which can throw a SAXException if the reader cannot be instantiated
- getRegexMatcher() - Method in class org.apache.commons.digester.RegexRules
-
Gets the current regex matching strategy.
- getRegistrations() - Method in class org.apache.commons.digester.Digester
-
Return the set of DTD URL registrations, keyed by public identifier.
- getRoot() - Method in class org.apache.commons.digester.Digester
-
Returns the root element of the tree of objects created as a result of applying the rule objects to the input XML.
- getRuleFinders() - Method in class org.apache.commons.digester.plugins.PluginContext
-
Return the list of RuleFinder objects.
- getRuleFinders() - Method in class org.apache.commons.digester.plugins.PluginRules
- getRuleNamespaceURI() - Method in class org.apache.commons.digester.Digester
-
Return the namespace URI that will be applied to all subsequently added
Rule
objects. - getRules() - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Returns the data structure the patterns/
AnnotationRuleProvider
pairs. - getRules() - Method in class org.apache.commons.digester.Digester
-
Return the
Rules
implementation object containing our rules collection and associated matching policy. - getRules(String) - Method in class org.apache.commons.digester.Digester
-
Deprecated.Call
match()
on theRules
implementation returned bygetRules()
- getRules(Digester) - Method in interface org.apache.commons.digester.xmlrules.DigesterRulesSource
-
Creates and adds Digester Rules to a given Rules object
- getRuleSet(Class<?>) - Method in class org.apache.commons.digester.annotations.DigesterLoader
-
Builds a new
RuleSet
analyzing the digester annotations in the target class. - getRulesFactory() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return the rules factory object (or null if one has not been specified).
- getSAXLogger() - Method in class org.apache.commons.digester.Digester
-
Gets the logger used for logging SAX-related information.
- getSchema() - Method in class org.apache.commons.digester.Digester
-
Deprecated.Use
Schema
for validation instead. - getSchemaLanguage() - Method in class org.apache.commons.digester.Digester
-
Deprecated.Use
Schema
for validation instead. - getStackAction() - Method in class org.apache.commons.digester.Digester
-
See setStackAction.
- getSubstitutor() - Method in class org.apache.commons.digester.Digester
-
Gets the
Substitutor
used to convert attributes and body text. - getTrimData() - Method in class org.apache.commons.digester.SetNestedPropertiesRule
- getType(int) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getType(String) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getType(String, String) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getURI(int) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getUseContextClassLoader() - Method in class org.apache.commons.digester.Digester
-
Return the boolean as to whether the context classloader should be used.
- getUseExactMatch() - Method in class org.apache.commons.digester.CallMethodRule
-
Should
MethodUtils.invokeExactMethod
be used for the reflection. - getValidating() - Method in class org.apache.commons.digester.Digester
-
Return the validating parser flag.
- getValue(int) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getValue(String) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getValue(String, String) - Method in class org.apache.commons.digester.substitution.VariableAttributes
- getXercesVersion() - Static method in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.Return the current Xerces version.
- getXIncludeAware() - Method in class org.apache.commons.digester.Digester
-
Return the XInclude-aware flag for parsers we create.
- getXMLReader() - Method in class org.apache.commons.digester.Digester
-
Return the XMLReader to be used for parsing the input document.
- getXMLSchema() - Method in class org.apache.commons.digester.Digester
-
Return the XML Schema used when parsing.
H
- handle(A, E, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.DigesterLoader
-
Handles the current visited element and related annotation, invoking the right handler putting the rule provider in the rule set.
- handle(A, E, FromAnnotationsRuleSet) - Method in interface org.apache.commons.digester.annotations.DigesterLoaderHandler
-
Handles the current visited element with the related current annotation.
- handle(Annotation, Method, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.handlers.MethodHandler
-
Handles the current visited element with the related current annotation.
- handle(AnnotatedElement, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.DigesterLoader
-
Executes an analysis for each annotation present in the element.
- handle(SetProperty, Field, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.handlers.SetPropertiesLoaderHandler
-
Handles the current visited element with the related current annotation.
- handledBy() - Element in annotation type org.apache.commons.digester.annotations.DigesterRule
-
The handler that takes care on converting this annotation in the related
AnnotationRuleProvider
and adds it o theFromAnnotationsRuleSet
I
- id - Variable in class org.apache.commons.digester.plugins.Declaration
- ignorableWhitespace(char[], int, int) - Method in class org.apache.commons.digester.Digester
-
Process notification of ignorable whitespace received from the body of an XML element.
- ignoreCreateExceptions - Variable in class org.apache.commons.digester.annotations.providers.FactoryCreateRuleProvider
- ignoreCreateExceptions - Variable in class org.apache.commons.digester.FactoryCreateRule
-
Should exceptions thrown by the factory be ignored?
- ignoreCreateExceptions() - Element in annotation type org.apache.commons.digester.annotations.rules.FactoryCreate
-
When true any exceptions thrown during object creation will be ignored.
- ignoreMissingProperty - Variable in class org.apache.commons.digester.SetPropertiesRule
-
Used to determine whether the parsing should fail if an property specified in the XML is missing from the bean.
- includedFiles - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Used to detect circular includes
- includeProgrammaticRules(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.IncludeRule
-
Creates an instance of the indicated class.
- IncludeRule() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.IncludeRule
- includeXMLRules(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.IncludeRule
-
Creates another DigesterRuleParser, and uses it to extract the rules out of the give XML file.
- index - Variable in class org.apache.commons.digester.annotations.providers.AttributeCallParamRuleProvider
- index - Variable in class org.apache.commons.digester.annotations.providers.CallParamRuleProvider
- index - Variable in class org.apache.commons.digester.annotations.providers.PathCallParamRuleProvider
- index - Variable in class org.apache.commons.digester.annotations.reflect.MethodArgument
-
The method argument index.
- init(A, E) - Method in interface org.apache.commons.digester.annotations.AnnotationRuleProvider
-
Initializes the provider.
- init(String, Rules) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- init(AttributeCallParam, MethodArgument) - Method in class org.apache.commons.digester.annotations.providers.AttributeCallParamRuleProvider
-
Initializes the provider.
- init(BeanPropertySetter, Field) - Method in class org.apache.commons.digester.annotations.providers.BeanPropertySetterRuleProvider
-
Initializes the provider.
- init(CallMethod, Method) - Method in class org.apache.commons.digester.annotations.providers.CallMethodRuleProvider
-
Initializes the provider.
- init(CallParam, MethodArgument) - Method in class org.apache.commons.digester.annotations.providers.CallParamRuleProvider
-
Initializes the provider.
- init(FactoryCreate, Class<?>) - Method in class org.apache.commons.digester.annotations.providers.FactoryCreateRuleProvider
-
Initializes the provider.
- init(ObjectCreate, Class<?>) - Method in class org.apache.commons.digester.annotations.providers.ObjectCreateRuleProvider
-
Initializes the provider.
- init(PathCallParam, MethodArgument) - Method in class org.apache.commons.digester.annotations.providers.PathCallParamRuleProvider
-
Initializes the provider.
- init(SetNext, Method) - Method in class org.apache.commons.digester.annotations.providers.SetNextRuleProvider
-
Initializes the provider.
- init(SetProperty, Field) - Method in class org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider
-
Initializes the provider.
- init(SetRoot, Method) - Method in class org.apache.commons.digester.annotations.providers.SetRootRuleProvider
-
Initializes the provider.
- init(SetTop, Method) - Method in class org.apache.commons.digester.annotations.providers.SetTopRuleProvider
-
Initializes the provider.
- init(StackCallParam, MethodArgument) - Method in class org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider
-
Initializes the provider.
- init(Digester, PluginManager) - Method in class org.apache.commons.digester.plugins.Declaration
-
Must be called exactly once, and must be called before any call to the configure method.
- init(FromXmlRuleSet.XMLRulesLoader, DigesterRuleParser, Digester) - Method in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
Base constructor
- init(Attributes, VariableExpander) - Method in class org.apache.commons.digester.substitution.VariableAttributes
-
Specify which attributes class this object is a proxy for.
- initException - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
-
Currently, none of the Rules methods allow exceptions to be thrown.
- InitializableRule - Interface in org.apache.commons.digester.plugins
-
Defines an interface that a Rule class can implement if it wishes to get an initialisation callback after the rule has been added to the set of Rules within a PluginRules instance.
- initialize() - Method in class org.apache.commons.digester.Digester
-
Provides a hook for lazy initialization of this
Digester
instance. - initialized - Variable in class org.apache.commons.digester.plugins.Declaration
- input - Variable in class org.apache.commons.digester.plugins.strategies.LoaderFromStream
- inputSource - Variable in class org.apache.commons.digester.xmlrules.FromXmlRuleSet.InputSourceXMLRulesLoader
- inputSources - Variable in class org.apache.commons.digester.Digester
-
List
ofInputSource
instances created by acreateInputSourceFromURL()
method call. - InputSourceXMLRulesLoader(InputSource) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet.InputSourceXMLRulesLoader
- invokeAnnotationMethod(Annotation, String) - Static method in class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
Invokes an annotation method.
- isAnnotationPresent(Class<? extends Annotation>) - Method in class org.apache.commons.digester.annotations.reflect.MethodArgument
- isEmpty(String) - Method in class org.apache.commons.digester.Digester
-
Is the stack with the given name empty?
- isExactMatch() - Method in class org.apache.commons.digester.SetNextRule
-
Is exact matching being used.
- isExactMatch() - Method in class org.apache.commons.digester.SetRootRule
-
Is exact matching being used.
- isExactMatch() - Method in class org.apache.commons.digester.SetTopRule
-
Is exact matching being used.
- isIgnoreMissingProperty() - Method in class org.apache.commons.digester.SetPropertiesRule
-
Are attributes found in the xml without matching properties to be ignored?
- isXercesUsed - Static variable in class org.apache.commons.digester.ParserFeatureSetterFactory
-
Deprecated.
true
is Xerces is used.
J
- JAXP_SCHEMA_LANGUAGE - Variable in class org.apache.commons.digester.Digester
-
Deprecated.This is now managed by
ParserFeatureSetterFactory
- JAXP_SCHEMA_LANGUAGE - Static variable in class org.apache.commons.digester.parser.GenericParser
-
Deprecated.The JAXP 1.2 property to set up the schemaLanguage used.
- JAXP_SCHEMA_LANGUAGE - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.The JAXP 1.2 property to set up the schemaLanguage used.
- JAXP_SCHEMA_SOURCE - Static variable in class org.apache.commons.digester.parser.GenericParser
-
Deprecated.The JAXP 1.2 property required to set up the schema location.
- JAXP_SCHEMA_SOURCE - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.The JAXP 1.2 property required to set up the schema location.
L
- load(InputStream) - Method in class org.apache.commons.digester.plugins.strategies.LoaderFromStream
-
The contents of the input stream are loaded into memory, and cached for later use.
- load(URL, ClassLoader, InputStream) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Given the digester rules XML file, a class loader, and an input stream, this method parses the input into Java objects.
- load(URL, ClassLoader, InputStream, Object) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Given the digester rules XML file, a class loader, and an input stream, this method parses the input into Java objects.
- load(URL, ClassLoader, Reader) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Given the digester rules XML file, a class loader, and an input stream, this method parses the input into Java objects.
- load(URL, ClassLoader, Reader, Object) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Given the digester rules XML file, a class loader, and an input stream, this method parses the input into Java objects.
- load(URL, ClassLoader, URL) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Given the digester rules XML file, a class loader, and an XML input file, this method parses the input file into Java objects.
- load(URL, ClassLoader, URL, Object) - Static method in class org.apache.commons.digester.xmlrules.DigesterLoader
-
Given the digester rules XML file, a class loader, and an XML input file, this method parses the input file into Java objects.
- LoaderFromClass - Class in org.apache.commons.digester.plugins.strategies
-
A RuleLoader which invokes a static method on a target class, leaving that method to actually instantiate and add new rules to a Digester instance.
- LoaderFromClass(Class<?>, Method) - Constructor for class org.apache.commons.digester.plugins.strategies.LoaderFromClass
-
Constructor.
- LoaderFromClass(Class<?>, String) - Constructor for class org.apache.commons.digester.plugins.strategies.LoaderFromClass
-
Constructor.
- LoaderFromStream - Class in org.apache.commons.digester.plugins.strategies
-
A rule-finding algorithm which loads an xmlplugins-format file.
- LoaderFromStream(InputStream) - Constructor for class org.apache.commons.digester.plugins.strategies.LoaderFromStream
- LoaderSetProperties - Class in org.apache.commons.digester.plugins.strategies
-
A RuleLoader which creates a single SetPropertiesRule and adds it to the digester when its addRules() method is invoked.
- LoaderSetProperties() - Constructor for class org.apache.commons.digester.plugins.strategies.LoaderSetProperties
- loadFactor - Variable in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
The fixed cache load facor.
- loadRules() - Method in class org.apache.commons.digester.xmlrules.FromXmlRuleSet.InputSourceXMLRulesLoader
- loadRules() - Method in class org.apache.commons.digester.xmlrules.FromXmlRuleSet.URLXMLRulesLoader
- loadRules() - Method in class org.apache.commons.digester.xmlrules.FromXmlRuleSet.XMLRulesLoader
-
Load rules now
- loadRules(Digester, Class<?>, InputStream, String) - Static method in class org.apache.commons.digester.plugins.strategies.FinderFromResource
-
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.
- locateMethod(Class<?>, String) - Static method in class org.apache.commons.digester.plugins.strategies.LoaderFromClass
-
Find a method on the specified class whose name matches methodName, and whose signature is:
public static void foo(Digester d, String patternPrefix);
. - locator - Variable in class org.apache.commons.digester.Digester
-
The Locator associated with our parser.
- log - Variable in class org.apache.commons.digester.Digester
-
The Log to which most logging calls will be made.
- log - Static variable in class org.apache.commons.digester.parser.GenericParser
-
Deprecated.The Log to which all SAX event related logging calls will be made.
- log - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.The Log to which all SAX event related logging calls will be made.
- log - Variable in class org.apache.commons.digester.SetNestedPropertiesRule
- log - Variable in class org.apache.commons.digester.SimpleRegexMatcher
-
Custom log (can be set per object)
- log(String) - Method in class org.apache.commons.digester.Digester
-
Deprecated.Call getLogger() and use it's logging methods
- log(String, Throwable) - Method in class org.apache.commons.digester.Digester
-
Deprecated.Call getLogger() and use it's logging methods
- LogUtils - Class in org.apache.commons.digester.plugins
-
Simple utility class to assist in logging.
- LogUtils() - Constructor for class org.apache.commons.digester.plugins.LogUtils
- lookup(String, String) - Method in class org.apache.commons.digester.RulesBase
-
Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any).
M
- mappedClasses - Variable in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Maintains all the classes that this RuleSet produces mapping for.
- mapsClass(Class<?>) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Checks if this RuleSet builds Digester mapping rules for the input type.
- markers - Variable in class org.apache.commons.digester.substitution.MultiVariableExpander
- match - Variable in class org.apache.commons.digester.Digester
-
The current match pattern for nested element processing.
- match(String) - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Deprecated.Call match(namespaceURI,pattern) instead.
- match(String) - Method in class org.apache.commons.digester.plugins.PluginRules
-
Deprecated.Call match(namespaceURI,pattern) instead.
- match(String) - Method in interface org.apache.commons.digester.Rules
-
Deprecated.Call match(namespaceURI,pattern) instead.
- match(String) - Method in class org.apache.commons.digester.RulesBase
-
Deprecated.Call match(namespaceURI,pattern) instead.
- match(String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- match(String) - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
- match(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
Deprecated.Call match(namespaceURI,pattern) instead.
- match(String, String) - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
- match(String, String) - Method in class org.apache.commons.digester.ExtendedBaseRules
-
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
- match(String, String) - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return a List of all registered Rule instances that match the specified nodepath, or a zero-length List if there are no matches.
- match(String, String) - Method in class org.apache.commons.digester.RegexMatcher
-
Returns true if the given pattern matches the given path according to the regex algorithm that this strategy applies.
- match(String, String) - Method in class org.apache.commons.digester.RegexRules
-
Finds matching rules by using current regex matching strategy.
- match(String, String) - Method in interface org.apache.commons.digester.Rules
-
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
- match(String, String) - Method in class org.apache.commons.digester.RulesBase
-
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
- match(String, String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- match(String, String) - Method in class org.apache.commons.digester.SimpleRegexMatcher
-
Matches using simple regex algorithm.
- match(String, String) - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Return list of rules matching given pattern.
- match(String, String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- match(String, String, int, int) - Method in class org.apache.commons.digester.SimpleRegexMatcher
-
Implementation of regex matching algorithm.
- matcher - Variable in class org.apache.commons.digester.RegexRules
-
The regex strategy used by this RegexRules
- matches - Variable in class org.apache.commons.digester.Digester
-
Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().
- matchPrefix - Variable in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- MethodArgument - Class in org.apache.commons.digester.annotations.reflect
-
Class to supply the missing Java
AnnotatedElement
for method arguments. - MethodArgument(int, Class<?>, Annotation[]) - Constructor for class org.apache.commons.digester.annotations.reflect.MethodArgument
-
Creates a new method argument as
AnnotatedElement
. - methodAttr - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromClass
- methodAttr - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromMethod
- MethodHandler - Class in org.apache.commons.digester.annotations.handlers
-
Handler that takes care to create the
SetNextRuleProvider
andSetRootRuleProvider
. - MethodHandler() - Constructor for class org.apache.commons.digester.annotations.handlers.MethodHandler
- methodName - Variable in class org.apache.commons.digester.annotations.providers.CallMethodRuleProvider
- methodName - Variable in class org.apache.commons.digester.annotations.providers.SetNextRuleProvider
- methodName - Variable in class org.apache.commons.digester.annotations.providers.SetRootRuleProvider
- methodName - Variable in class org.apache.commons.digester.annotations.providers.SetTopRuleProvider
- methodName - Variable in class org.apache.commons.digester.CallMethodRule
-
The method name to call on the parent object.
- methodName - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
- methodName - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltMethod
- methodName - Variable in class org.apache.commons.digester.SetNextRule
-
The method name to call on the parent object.
- methodName - Variable in class org.apache.commons.digester.SetRootRule
-
The method name to call on the parent object.
- methodName - Variable in class org.apache.commons.digester.SetTopRule
-
The method name to call on the child object.
- mountPoint - Variable in class org.apache.commons.digester.plugins.PluginRules
-
The path below which this rules object has responsibility.
- MultiVariableExpander - Class in org.apache.commons.digester.substitution
-
Expands variable references from multiple sources.
- MultiVariableExpander() - Constructor for class org.apache.commons.digester.substitution.MultiVariableExpander
N
- name - Variable in class org.apache.commons.digester.annotations.providers.BeanPropertySetterRuleProvider
- name - Variable in class org.apache.commons.digester.SetPropertyRule
-
The attribute that will contain the property name.
- namespaceAware - Variable in class org.apache.commons.digester.Digester
-
Do we want a "namespace aware" parser.
- namespaces - Variable in class org.apache.commons.digester.Digester
-
Registered namespaces we are currently processing.
- namespaceURI - Variable in class org.apache.commons.digester.AbstractRulesImpl
-
Namespace uri to assoicate with subsequent
Rule
's - namespaceURI - Variable in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
The namespace URI.
- namespaceURI - Variable in class org.apache.commons.digester.Rule
-
The namespace URI for which this Rule is relevant, if any.
- namespaceURI - Variable in class org.apache.commons.digester.RulesBase
-
The namespace URI for which subsequently added
Rule
objects are relevant, ornull
for matching independent of namespaces. - namespaceURI - Variable in class org.apache.commons.digester.RuleSetBase
-
The namespace URI that all Rule instances created by this RuleSet will be associated with.
- nEntries - Variable in class org.apache.commons.digester.substitution.MultiVariableExpander
- newInstance(Class<L>) - Method in class org.apache.commons.digester.annotations.internal.DefaultDigesterLoaderHandlerFactory
-
Return an instance of the specified type.
- newInstance(Class<L>) - Method in interface org.apache.commons.digester.annotations.spi.DigesterLoaderHandlerFactory
-
Return an instance of the specified type.
- newInstance(Class<T>) - Method in class org.apache.commons.digester.annotations.internal.DefaultAnnotationRuleProviderFactory
-
Return an
AnnotationRuleProvider
instance of the specified type. - newInstance(Class<T>) - Method in interface org.apache.commons.digester.annotations.spi.AnnotationRuleProviderFactory
-
Return an
AnnotationRuleProvider
instance of the specified type. - newRules(Digester, Class<?>) - Method in class org.apache.commons.digester.plugins.RulesFactory
-
Return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing rules.
- newSAXParser(Properties) - Static method in class org.apache.commons.digester.parser.GenericParser
-
Deprecated.Create a
SAXParser
configured to support XML Scheman and DTD - newSAXParser(Properties) - Static method in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.Create a
SAXParser
based on the underlyingXerces
version. - newSAXParser(Properties) - Static method in class org.apache.commons.digester.ParserFeatureSetterFactory
-
Deprecated.Create a new
SAXParser
- NodeBuilder(Document, Node) - Constructor for class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Constructor.
- NodeCreateRule - Class in org.apache.commons.digester
-
A rule implementation that creates a DOM
Node
containing the XML at the element that matched the rule. - NodeCreateRule() - Constructor for class org.apache.commons.digester.NodeCreateRule
-
Default constructor.
- NodeCreateRule(int) - Constructor for class org.apache.commons.digester.NodeCreateRule
-
Constructor.
- NodeCreateRule(int, DocumentBuilder) - Constructor for class org.apache.commons.digester.NodeCreateRule
-
Constructor.
- NodeCreateRule(DocumentBuilder) - Constructor for class org.apache.commons.digester.NodeCreateRule
-
Constructor.
- NodeCreateRule.NodeBuilder - Class in org.apache.commons.digester
-
The SAX content handler that does all the actual work of assembling the DOM node tree from the SAX events.
- NodeCreateRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.NodeCreateRuleFactory
- nodeType - Variable in class org.apache.commons.digester.NodeCreateRule
-
The type of the node that should be created.
- notationDecl(String, String, String) - Method in class org.apache.commons.digester.Digester
-
Receive notification of a notation declaration event.
O
- ObjectCreate - Annotation Type in org.apache.commons.digester.annotations.rules
-
Classes annotated with
ObjectCreate
will be bound withObjectCreateRule
digester rule. - ObjectCreate.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@ObjectCreate
annotations on the same element. - ObjectCreateRule - Class in org.apache.commons.digester
-
Rule implementation that creates a new object and pushes it onto the object stack.
- ObjectCreateRule(Class<?>) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Construct an object create rule with the specified class.
- ObjectCreateRule(String) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Construct an object create rule with the specified class name.
- ObjectCreateRule(String, Class<?>) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Construct an object create rule with the specified class and an optional attribute name containing an override.
- ObjectCreateRule(String, String) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Construct an object create rule with the specified class name and an optional attribute name containing an override.
- ObjectCreateRule(Digester, Class<?>) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseObjectCreateRule(Class clazz)
instead. - ObjectCreateRule(Digester, String) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseObjectCreateRule(String className)
instead. - ObjectCreateRule(Digester, String, Class<?>) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseObjectCreateRule(String attributeName, Class clazz)
instead. - ObjectCreateRule(Digester, String, String) - Constructor for class org.apache.commons.digester.ObjectCreateRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseObjectCreateRule(String className, String attributeName)
instead. - ObjectCreateRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.ObjectCreateRuleFactory
- ObjectCreateRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
ObjectCreateRule
. - ObjectCreateRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.ObjectCreateRuleProvider
- ObjectCreationFactory - Interface in org.apache.commons.digester
-
Interface for use with
FactoryCreateRule
. - ObjectParamRule - Class in org.apache.commons.digester
-
Rule implementation that saves a parameter for use by a surrounding
CallMethodRule
.
- ObjectParamRule(int, Object) - Constructor for class org.apache.commons.digester.ObjectParamRule
-
Construct a "call parameter" rule that will save the given Object as the parameter value.
- ObjectParamRule(int, String, Object) - Constructor for class org.apache.commons.digester.ObjectParamRule
-
Construct a "call parameter" rule that will save the given Object as the parameter value, provided that the specified attribute exists.
- ObjectParamRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.ObjectParamRuleFactory
- oldContentHandler - Variable in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
The content handler used by Digester before it was set to this content handler.
- onPop(Digester, String, Object) - Method in interface org.apache.commons.digester.StackAction
-
Invoked just after an object has been popped from a digester stack.
- onPush(Digester, String, Object) - Method in interface org.apache.commons.digester.StackAction
-
Invoked just before an object is to be pushed onto a digester stack.
- order - Variable in class org.apache.commons.digester.ExtendedBaseRules
-
The decision algorithm used (unfortunately) doesn't preserve the entry order.
- org.apache.commons.digester - package org.apache.commons.digester
-
The
xmlrules
package provides for XML-based definition of rules forDigester
. - org.apache.commons.digester.annotations - package org.apache.commons.digester.annotations
-
The
annotations
package provides for Java5 Annotations meta data-based definition of rules forDigester
. - org.apache.commons.digester.annotations.handlers - package org.apache.commons.digester.annotations.handlers
-
The
handlers
package containsDigesterLoaderHandler
implementations. - org.apache.commons.digester.annotations.internal - package org.apache.commons.digester.annotations.internal
-
This package contains internal use only classes, users can ignore it.
- org.apache.commons.digester.annotations.providers - package org.apache.commons.digester.annotations.providers
-
This package contains
AnnotationRuleProvider
implementations. - org.apache.commons.digester.annotations.reflect - package org.apache.commons.digester.annotations.reflect
-
The
reflect
package supply missing JVM classes to alow user manipulate entities asAnnotatedElement
. - org.apache.commons.digester.annotations.rules - package org.apache.commons.digester.annotations.rules
-
Classes contained in this package are annotations that reflect Digester rules.
- org.apache.commons.digester.annotations.spi - package org.apache.commons.digester.annotations.spi
-
Contains annotations package SPI definition.
- org.apache.commons.digester.annotations.utils - package org.apache.commons.digester.annotations.utils
-
Contains commons utilities classes for Java5 Annotations manipulation.
- org.apache.commons.digester.parser - package org.apache.commons.digester.parser
-
DEPRECATED PACKAGE:
This package contains legacy schema support code used in the v1.x line of Digester releases. - org.apache.commons.digester.plugins - package 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 - package 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.substitution - package org.apache.commons.digester.substitution
-
The
substitution
provides for manipulation of xml attributes and element body text before the data is processed by any Rule objects. - org.apache.commons.digester.xmlrules - package 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.
P
- param - Variable in class org.apache.commons.digester.ObjectParamRule
-
The parameter we wish to pass to the method call
- paramClassNames - Variable in class org.apache.commons.digester.CallMethodRule
-
The names of the classes of the parameters to be collected.
- paramCount - Variable in class org.apache.commons.digester.CallMethodRule
-
The number of parameters to collect from
MethodParam
rules. - parameterType - Variable in class org.apache.commons.digester.annotations.reflect.MethodArgument
-
The method argument type.
- parameterTypes - Variable in class org.apache.commons.digester.annotations.providers.CallMethodRuleProvider
- paramIndex - Variable in class org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider
- paramIndex - Variable in class org.apache.commons.digester.CallParamRule
-
The zero-relative index of the parameter we are saving.
- paramIndex - Variable in class org.apache.commons.digester.ObjectParamRule
-
The zero-relative index of the parameter we are saving.
- paramIndex - Variable in class org.apache.commons.digester.PathCallParamRule
-
The zero-relative index of the parameter we are saving.
- params - Variable in class org.apache.commons.digester.Digester
-
The parameters stack being utilized by CallMethodRule and CallParamRule rules.
- paramType - Variable in class org.apache.commons.digester.annotations.providers.SetNextRuleProvider
- paramType - Variable in class org.apache.commons.digester.annotations.providers.SetRootRuleProvider
- paramType - Variable in class org.apache.commons.digester.annotations.providers.SetTopRuleProvider
- paramType - Variable in class org.apache.commons.digester.SetNextRule
-
The Java class name of the parameter type expected by the method.
- paramType - Variable in class org.apache.commons.digester.SetRootRule
-
The Java class name of the parameter type expected by the method.
- paramType - Variable in class org.apache.commons.digester.SetTopRule
-
The Java class name of the parameter type expected by the method.
- paramTypes - Variable in class org.apache.commons.digester.CallMethodRule
-
The parameter types of the parameters to be collected.
- parent - Variable in class org.apache.commons.digester.plugins.PluginManager
-
the parent manager to which this one may delegate lookups.
- parent - Variable in class org.apache.commons.digester.plugins.PluginRules
-
The Rules object that holds rules applying "above" the mountpoint, ie the next Rules object down in the stack.
- parentMatch(String, String, String) - Method in class org.apache.commons.digester.ExtendedBaseRules
-
Matching parent.
- parse(File) - Method in class org.apache.commons.digester.Digester
-
Parse the content of the specified file using this Digester.
- parse(InputStream) - Method in class org.apache.commons.digester.Digester
-
Parse the content of the specified input stream using this Digester.
- parse(Reader) - Method in class org.apache.commons.digester.Digester
-
Parse the content of the specified reader using this Digester.
- parse(String) - Method in class org.apache.commons.digester.Digester
-
Parse the content of the specified URI using this Digester.
- parse(URL) - Method in class org.apache.commons.digester.Digester
-
Parse the content of the specified URL using this Digester.
- parse(InputSource) - Method in class org.apache.commons.digester.Digester
-
Parse the content of the specified input source using this Digester.
- parser - Variable in class org.apache.commons.digester.Digester
-
The SAXParser we will use to parse the input stream.
- parser - Variable in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
The rule set for parsing the Digester rules
- ParserFeatureSetterFactory - Class in org.apache.commons.digester
-
Deprecated.Create an XMLParser instance yourself, configure validation appropriately, and pass it as a parameter to the
Digester
constructor, or useDigester.setXMLSchema(javax.xml.validation.Schema)
for validation. - ParserFeatureSetterFactory() - Constructor for class org.apache.commons.digester.ParserFeatureSetterFactory
-
Deprecated.
- PathCallParam - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods arguments annotated with
PathCallParam
will be bound withPathCallParamRule
digester rule. - PathCallParam.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@PathCallParam
annotations on the same element. - PathCallParamRule - Class in org.apache.commons.digester
-
Rule implementation that saves a parameter containing the
Digester
matching path for use by a surroundingCallMethodRule
. - PathCallParamRule(int) - Constructor for class org.apache.commons.digester.PathCallParamRule
-
Construct a "call parameter" rule that will save the body text of this element as the parameter value.
- PathCallParamRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
PathCallParamRule
. - PathCallParamRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.PathCallParamRuleProvider
- pattern - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
-
In order to invoke the addRules method on the plugin class correctly, we need to know the pattern which this rule is matched by.
- pattern - Variable in class org.apache.commons.digester.RegexRules.RegisteredRule
- pattern - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternRule
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.AttributeCallParam
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.BeanPropertySetter
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.CallMethod
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.CallParam
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.FactoryCreate
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.ObjectCreate
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.PathCallParam
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.SetProperty
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.SetTop
-
The element matching pattern.
- pattern() - Element in annotation type org.apache.commons.digester.annotations.rules.StackCallParam
-
The element matching pattern.
- PATTERN - Static variable in class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
The
pattern
string constant. - PatternRule(String) - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternRule
- patternStack - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
A stack used to maintain the current pattern.
- PatternStack() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternStack
- peek() - Method in class org.apache.commons.digester.Digester
-
Return the top object on the stack without removing it.
- peek(int) - Method in class org.apache.commons.digester.Digester
-
Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element.
- peek(String) - Method in class org.apache.commons.digester.Digester
-
Gets the top object from the stack with the given name.
- peek(String, int) - Method in class org.apache.commons.digester.Digester
-
Gets the top object from the stack with the given name.
- peekParams() - Method in class org.apache.commons.digester.Digester
-
Return the top object on the parameters stack without removing it.
- peekParams(int) - Method in class org.apache.commons.digester.Digester
-
Return the n'th object down the parameters stack, where 0 is the top element and [getCount()-1] is the bottom element.
- PluginAssertionFailure - Exception in org.apache.commons.digester.plugins
-
Thrown when a bug is detected in the plugins code.
- PluginAssertionFailure(String) - Constructor for exception org.apache.commons.digester.plugins.PluginAssertionFailure
- PluginAssertionFailure(String, Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginAssertionFailure
- PluginAssertionFailure(Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginAssertionFailure
- pluginClass - Variable in class org.apache.commons.digester.plugins.Declaration
-
The class of the object to be instantiated.
- pluginClassAttr - Variable in class org.apache.commons.digester.plugins.PluginContext
- pluginClassAttr - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
- pluginClassAttrNs - Variable in class org.apache.commons.digester.plugins.PluginContext
- pluginClassAttrNs - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
- pluginClassName - Variable in class org.apache.commons.digester.plugins.Declaration
-
The name of the class of the object to be instantiated.
- PluginConfigurationException - Exception in org.apache.commons.digester.plugins
-
Thrown when an error occurs due to the way the calling application uses the plugins module.
- PluginConfigurationException(String) - Constructor for exception org.apache.commons.digester.plugins.PluginConfigurationException
- PluginConfigurationException(String, Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginConfigurationException
- PluginConfigurationException(Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginConfigurationException
- pluginContext - Variable in class org.apache.commons.digester.plugins.PluginManager
-
The object containing data that should only exist once for each Digester instance.
- pluginContext - Variable in class org.apache.commons.digester.plugins.PluginRules
-
A reference to the object that holds all data which should only exist once per digester instance.
- PluginContext - Class in org.apache.commons.digester.plugins
-
Provides data and services which should exist only once per digester.
- PluginContext() - Constructor for class org.apache.commons.digester.plugins.PluginContext
- PluginCreateRule - Class in org.apache.commons.digester.plugins
-
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.
- PluginCreateRule(Class<?>) - Constructor for class org.apache.commons.digester.plugins.PluginCreateRule
-
Create a plugin rule where the user must specify a plugin-class or plugin-id.
- PluginCreateRule(Class<?>, Class<?>) - Constructor for class org.apache.commons.digester.plugins.PluginCreateRule
-
Create a plugin rule where the user may specify a plugin.
- PluginCreateRule(Class<?>, Class<?>, RuleLoader) - Constructor for class org.apache.commons.digester.plugins.PluginCreateRule
-
Create a plugin rule where the user may specify a plugin.
- PluginDeclarationRule - Class in org.apache.commons.digester.plugins
-
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.
- PluginDeclarationRule() - Constructor for class org.apache.commons.digester.plugins.PluginDeclarationRule
-
constructor
- PluginException - Exception in org.apache.commons.digester.plugins
-
Thrown when some plugin-related error has occurred, and none of the other exception types are appropriate.
- PluginException(String) - Constructor for exception org.apache.commons.digester.plugins.PluginException
- PluginException(String, Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginException
- PluginException(Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginException
- pluginIdAttr - Variable in class org.apache.commons.digester.plugins.PluginContext
- pluginIdAttr - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
- pluginIdAttrNs - Variable in class org.apache.commons.digester.plugins.PluginContext
- pluginIdAttrNs - Variable in class org.apache.commons.digester.plugins.PluginCreateRule
- PluginInvalidInputException - Exception in org.apache.commons.digester.plugins
-
Thrown when an error occurs due to bad data in the file being parsed.
- PluginInvalidInputException(String) - Constructor for exception org.apache.commons.digester.plugins.PluginInvalidInputException
- PluginInvalidInputException(String, Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginInvalidInputException
- PluginInvalidInputException(Throwable) - Constructor for exception org.apache.commons.digester.plugins.PluginInvalidInputException
- pluginManager - Variable in class org.apache.commons.digester.plugins.PluginRules
-
Object which contains information about all known plugins.
- PluginManager - Class in org.apache.commons.digester.plugins
-
Coordinates between PluginDeclarationRule and PluginCreateRule objects, providing a place to share data between instances of these rules.
- PluginManager(PluginContext) - Constructor for class org.apache.commons.digester.plugins.PluginManager
-
Construct a "root" PluginManager, ie one with no parent.
- PluginManager(PluginManager) - Constructor for class org.apache.commons.digester.plugins.PluginManager
-
Construct a "child" PluginManager.
- PluginRules - Class in org.apache.commons.digester.plugins
-
A custom digester Rules manager which must be used as the Rules object when using the plugins module functionality.
- PluginRules() - Constructor for class org.apache.commons.digester.plugins.PluginRules
-
Constructor for top-level Rules objects.
- PluginRules(Digester, String, PluginRules, Class<?>) - Constructor for class org.apache.commons.digester.plugins.PluginRules
-
Constructs a Rules instance which has a parent Rules object (which is different from having a delegate rules object).
- PluginRules(Rules) - Constructor for class org.apache.commons.digester.plugins.PluginRules
-
Constructor for top-level Rules object which handles rule-matching using the specified implementation.
- pop() - Method in class org.apache.commons.digester.Digester
-
Pop the top object off of the stack, and return it.
- pop(String) - Method in class org.apache.commons.digester.Digester
-
Pops (gets and removes) the top object from the stack with the given name.
- popParams() - Method in class org.apache.commons.digester.Digester
-
Pop the top object off of the parameters stack, and return it.
- postRegisterInit(String) - Method in interface org.apache.commons.digester.plugins.InitializableRule
-
Called after this Rule object has been added to the list of all Rules.
- postRegisterInit(String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Invoked after this rule has been added to the set of digester rules, associated with the specified pattern.
- prefix - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
- processingInstruction(String, String) - Method in class org.apache.commons.digester.Digester
-
Process notification of a processing instruction that was encountered.
- processingInstruction(String, String) - Method in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Adds a new
ProcessingInstruction
to the current node. - processMethodCallResult(Object) - Method in class org.apache.commons.digester.CallMethodRule
-
Subclasses may override this method to perform additional processing of the invoked method's result.
- properties - Variable in class org.apache.commons.digester.plugins.Declaration
- propertyName - Variable in class org.apache.commons.digester.BeanPropertySetterRule
-
Set this property on the top object.
- propertyNames - Variable in class org.apache.commons.digester.SetPropertiesRule
-
Property names used to override natural attribute->property mapping
- propsAttr - Variable in class org.apache.commons.digester.plugins.strategies.FinderSetProperties
- providedBy() - Element in annotation type org.apache.commons.digester.annotations.DigesterRule
-
Define the
AnnotationRuleProvider
that builds theRule
related to the digester rule. - publicId - Variable in class org.apache.commons.digester.Digester
-
The public identifier of the DTD we are currently parsing under (if any).
- push(Object) - Method in class org.apache.commons.digester.Digester
-
Push a new object onto the top of the object stack.
- push(String, Object) - Method in class org.apache.commons.digester.Digester
-
Pushes the given object onto the stack with the given name.
- pushParams(Object) - Method in class org.apache.commons.digester.Digester
-
Push a new object onto the top of the parameters stack.
- put(Class<?>, FromAnnotationsRuleSet) - Method in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
Associates the specified value with the specified key in this cache.
R
- reader - Variable in class org.apache.commons.digester.Digester
-
The XMLReader used to parse digester rules.
- reflectsRule() - Element in annotation type org.apache.commons.digester.annotations.DigesterRule
-
The reflected commons-digester rule.
- RegexMatcher - Class in org.apache.commons.digester
-
Regular expression matching strategy for RegexRules.
- RegexMatcher() - Constructor for class org.apache.commons.digester.RegexMatcher
- RegexRules - Class in org.apache.commons.digester
-
Rules implementation that uses regular expression matching for paths.
- RegexRules(RegexMatcher) - Constructor for class org.apache.commons.digester.RegexRules
-
Construct sets the Regex matching strategy.
- RegexRules.RegisteredRule - Class in org.apache.commons.digester
-
Used to associate rules with paths in the rules list
- register(String, String) - Method in class org.apache.commons.digester.Digester
-
Convenience method that registers the string version of an entity URL instead of a URL version.
- register(String, URL) - Method in class org.apache.commons.digester.Digester
-
Register the specified DTD URL for the specified public identifier.
- RegisteredRule(String, Rule) - Constructor for class org.apache.commons.digester.RegexRules.RegisteredRule
- registeredRules - Variable in class org.apache.commons.digester.RegexRules
-
All registered
Rule
's - registerRule(String, Rule) - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Register rule at given pattern.
- registerRule(String, Rule) - Method in class org.apache.commons.digester.RegexRules
-
Register a new Rule instance matching the specified pattern.
- resetRoot() - Method in class org.apache.commons.digester.Digester
-
This method allows the "root" variable to be reset to null.
- resolveEntity(String, String) - Method in class org.apache.commons.digester.Digester
-
Resolve the requested external entity.
- resourceAttr - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromResource
- resourceSuffix - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltResource
- root - Variable in class org.apache.commons.digester.Digester
-
The "root" element of the stack (in other words, the last object that was popped.
- root - Variable in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
The DOM node that will be pushed on Digester's stack.
- rule - Variable in class org.apache.commons.digester.RegexRules.RegisteredRule
- rule - Variable in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- Rule - Class in org.apache.commons.digester
-
Concrete implementations of this class implement actions to be taken when a corresponding nested pattern of XML elements has been matched.
- Rule() - Constructor for class org.apache.commons.digester.Rule
-
Base constructor.
- Rule(Digester) - Constructor for class org.apache.commons.digester.Rule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseRule()
instead. - ruleClassAttr - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromClass
- RuleFinder - Class in org.apache.commons.digester.plugins
-
Each concrete implementation of RuleFinder is an algorithm for locating a source of digester rules for a plugin.
- RuleFinder() - Constructor for class org.apache.commons.digester.plugins.RuleFinder
- ruleFinders - Variable in class org.apache.commons.digester.plugins.PluginContext
-
A list of RuleFinder objects used by all Declarations (and thus indirectly by all PluginCreateRules to locate the custom rules for plugin classes.
- ruleLoader - Variable in class org.apache.commons.digester.plugins.Declaration
-
Class which is responsible for dynamically loading this plugin's rules on demand.
- RuleLoader - Class in org.apache.commons.digester.plugins
-
Interface for classes which can dynamically load custom plugin rules associated with a user's plugin class.
- RuleLoader() - Constructor for class org.apache.commons.digester.plugins.RuleLoader
- rules - Variable in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
The data structure that stores the patterns/
AnnotationRuleProvider
pairs. - rules - Variable in class org.apache.commons.digester.Digester
-
The
Rules
implementation containing our collection ofRule
instances and associated matching policy. - rules - Variable in class org.apache.commons.digester.RulesBase
-
The set of registered Rule instances, in the order that they were originally registered.
- rules - Variable in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- rules() - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
- rules() - Method in class org.apache.commons.digester.plugins.PluginRules
-
Return the list of rules registered with this object, in the order they were registered with this object.
- rules() - Method in class org.apache.commons.digester.RegexRules
-
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
- rules() - Method in interface org.apache.commons.digester.Rules
-
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
- rules() - Method in class org.apache.commons.digester.RulesBase
-
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
- rules() - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- rules() - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Gets all rules
- rules() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- Rules - Interface in org.apache.commons.digester
-
Public interface defining a collection of Rule instances (and corresponding matching patterns) plus an implementation of a matching policy that selects the rules that match a particular pattern of nested elements discovered during parsing.
- RulesBase - Class in org.apache.commons.digester
-
Default implementation of the
Rules
interface that supports the standard rule matching behavior. - RulesBase() - Constructor for class org.apache.commons.digester.RulesBase
- rulesClass - Variable in class org.apache.commons.digester.plugins.strategies.LoaderFromClass
- rulesClassSuffix - Variable in class org.apache.commons.digester.plugins.strategies.FinderFromDfltClass
- rulesDigester - Variable in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
The digester for loading the rules xml.
- RuleSet - Interface in org.apache.commons.digester
-
Public interface defining a shorthand means of configuring a complete set of related
Rule
definitions, possibly associated with a particular namespace URI, in one operation. - RuleSetBase - Class in org.apache.commons.digester
-
Convenience base class that implements the
RuleSet
interface. - RuleSetBase() - Constructor for class org.apache.commons.digester.RuleSetBase
- RuleSetCache - Class in org.apache.commons.digester.annotations.internal
-
Simple in-memory LRU cache implementation.
- RuleSetCache() - Constructor for class org.apache.commons.digester.annotations.internal.RuleSetCache
- rulesFactory - Variable in class org.apache.commons.digester.plugins.PluginRules
-
The (optional) object which generates new rules instances.
- RulesFactory - Class in org.apache.commons.digester.plugins
-
Whenever the scope of a plugin tag is entered, the PluginRules class creates a new Rules instance and configures it with the appropriate parsing rules for the plugged-in class.
- RulesFactory() - Constructor for class org.apache.commons.digester.plugins.RulesFactory
- rulesLoader - Variable in class org.apache.commons.digester.xmlrules.FromXmlRuleSet
-
The file containing the Digester rules, in XML.
- rulesMethod - Variable in class org.apache.commons.digester.plugins.strategies.LoaderFromClass
- RulesPrefixAdapter(String, Rules) - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
S
- saxLog - Variable in class org.apache.commons.digester.Digester
-
The Log to which all SAX event related logging calls will be made.
- schema - Variable in class org.apache.commons.digester.Digester
-
The XML schema to use for validating an XML instance.
- schemaLanguage - Variable in class org.apache.commons.digester.Digester
-
Deprecated.Use
Schema
support instead. - schemaLocation - Variable in class org.apache.commons.digester.Digester
-
Deprecated.Use
Schema
support instead. - serialVersionUID - Static variable in exception org.apache.commons.digester.annotations.DigesterLoadingException
-
The default serial version UID.
- serialVersionUID - Static variable in class org.apache.commons.digester.annotations.internal.RuleSetCache
-
This class serialVersionUID.
- serialVersionUID - Static variable in exception org.apache.commons.digester.plugins.PluginAssertionFailure
- serialVersionUID - Static variable in exception org.apache.commons.digester.plugins.PluginConfigurationException
- serialVersionUID - Static variable in exception org.apache.commons.digester.plugins.PluginException
- serialVersionUID - Static variable in exception org.apache.commons.digester.plugins.PluginInvalidInputException
- serialVersionUID - Static variable in exception org.apache.commons.digester.xmlrules.CircularIncludeException
- serialVersionUID - Static variable in exception org.apache.commons.digester.xmlrules.DigesterLoadingException
- serialVersionUID - Static variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternStack
- serialVersionUID - Static variable in exception org.apache.commons.digester.xmlrules.XmlLoadException
- setAllowUnknownChildElements(boolean) - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
Determines whether an error is reported when a nested element is encountered for which there is no corresponding property-setter method.
- setBasePath(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Set a base pattern beneath which all the rules loaded by this object will be registered.
- setClassLoader(ClassLoader) - Method in class org.apache.commons.digester.Digester
-
Set the class loader to be used for instantiating application objects when required.
- setCustomContentHandler(ContentHandler) - Method in class org.apache.commons.digester.Digester
-
Redirects (or cancels redirecting) of SAX ContentHandler events to an external object.
- setDebug(int) - Method in class org.apache.commons.digester.Digester
-
Deprecated.This method now has no effect at all. Digester uses the apache jakarta comons-logging library; see the documentation for that library for more information.
- setDigester(Digester) - Method in class org.apache.commons.digester.AbstractObjectCreationFactory
-
Set the
Digester
to allow the implementation to do logging, classloading based on the digester's classloader, etc. - setDigester(Digester) - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Set the Digester instance with which this Rules instance is associated.
- setDigester(Digester) - Method in class org.apache.commons.digester.CallMethodRule
-
Set the associated digester.
- setDigester(Digester) - Method in interface org.apache.commons.digester.ObjectCreationFactory
-
Set the
Digester
to allow the implementation to do logging, classloading based on the digester's classloader, etc. - setDigester(Digester) - Method in class org.apache.commons.digester.plugins.PluginRules
-
Set the Digester instance with which this Rules instance is associated.
- setDigester(Digester) - Method in class org.apache.commons.digester.Rule
-
Set the
Digester
with which thisRule
is associated. - setDigester(Digester) - Method in interface org.apache.commons.digester.Rules
-
Set the Digester instance with which this Rules instance is associated.
- setDigester(Digester) - Method in class org.apache.commons.digester.RulesBase
-
Set the Digester instance with which this Rules instance is associated.
- setDigester(Digester) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- setDigester(Digester) - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
Invoked when rule is added to digester.
- setDigester(Digester) - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Sets digeseter using these Rules
- setDigester(Digester) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- setDigesterRulesDTD(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Sets the location of the digester rules DTD.
- setDocumentLocator(Locator) - Method in class org.apache.commons.digester.Digester
-
Sets the document locator associated with our parser.
- setEntityResolver(EntityResolver) - Method in class org.apache.commons.digester.Digester
-
Set the
EntityResolver
used by SAX when resolving public id and system id. - setErrorHandler(ErrorHandler) - Method in class org.apache.commons.digester.Digester
-
Set the error handler for this Digester.
- setExactMatch(boolean) - Method in class org.apache.commons.digester.SetNextRule
-
Set whether exact matching is enabled.
- setExactMatch(boolean) - Method in class org.apache.commons.digester.SetRootRule
-
Set whether exact matching is enabled.
- setExactMatch(boolean) - Method in class org.apache.commons.digester.SetTopRule
-
Set whether exact matching is enabled.
- setFeature(String, boolean) - Method in class org.apache.commons.digester.Digester
-
Sets a flag indicating whether the requested feature is supported by the underlying implementation of
org.xml.sax.XMLReader
. - setId(String) - Method in class org.apache.commons.digester.plugins.Declaration
-
The id that the user associated with a particular plugin declaration in the input xml.
- setIgnoreMissingProperty(boolean) - Method in class org.apache.commons.digester.SetPropertiesRule
-
Sets whether attributes found in the xml without matching properties should be ignored.
- setLog(Log) - Method in class org.apache.commons.digester.SimpleRegexMatcher
-
Sets the current
Log
implementation used by this class. - setLogger(Log) - Method in class org.apache.commons.digester.Digester
-
Set the current logger for this Digester.
- setNamespaceAware(boolean) - Method in class org.apache.commons.digester.Digester
-
Set the "namespace aware" flag for parsers we create.
- setNamespaceURI(String) - Method in class org.apache.commons.digester.AbstractRulesImpl
-
Set the namespace URI that will be applied to all subsequently added
Rule
objects. - setNamespaceURI(String) - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
-
Sets the namespace URI that will be applied to all Rule instances created from this RuleSet.
- setNamespaceURI(String) - Method in class org.apache.commons.digester.plugins.PluginRules
-
Set the namespace URI that will be applied to all subsequently added
Rule
objects. - setNamespaceURI(String) - Method in class org.apache.commons.digester.Rule
-
Set the namespace URI for which this Rule is relevant, if any.
- setNamespaceURI(String) - Method in interface org.apache.commons.digester.Rules
-
Set the namespace URI that will be applied to all subsequently added
Rule
objects. - setNamespaceURI(String) - Method in class org.apache.commons.digester.RulesBase
-
Set the namespace URI that will be applied to all subsequently added
Rule
objects. - setNamespaceURI(String) - Method in class org.apache.commons.digester.SetNestedPropertiesRule.AnyChildRules
- setNamespaceURI(String) - Method in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Sets namespace to apply to Rule's added subsequently
- setNamespaceURI(String) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.RulesPrefixAdapter
-
This method passes through to the underlying Rules object.
- SetNestedPropertiesAliasRule() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetNestedPropertiesAliasRule
-
Base constructor.
- SetNestedPropertiesRule - Class in org.apache.commons.digester
-
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.
- SetNestedPropertiesRule() - Constructor for class org.apache.commons.digester.SetNestedPropertiesRule
-
Base constructor, which maps every child element into a bean property with the same name as the xml element.
- SetNestedPropertiesRule(String[], String[]) - Constructor for class org.apache.commons.digester.SetNestedPropertiesRule
-
Constructor which allows element->property mapping to be overridden.
- SetNestedPropertiesRule(String, String) - Constructor for class org.apache.commons.digester.SetNestedPropertiesRule
-
Convenience constructor which overrides the default mappings for just one property.
- SetNestedPropertiesRule.AnyChildRule - Class in org.apache.commons.digester
- SetNestedPropertiesRule.AnyChildRules - Class in org.apache.commons.digester
-
Private Rules implementation
- SetNestedPropertiesRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetNestedPropertiesRuleFactory
- SetNext - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods annotated with
SetNext
will be bound withSetNextRule
digester rule. - SetNextRule - Class in org.apache.commons.digester
-
Rule implementation that calls a method on the (top-1) (parent) object, passing the top object (child) as an argument.
- SetNextRule(String) - Constructor for class org.apache.commons.digester.SetNextRule
-
Construct a "set next" rule with the specified method name.
- SetNextRule(String, String) - Constructor for class org.apache.commons.digester.SetNextRule
-
Construct a "set next" rule with the specified method name.
- SetNextRule(Digester, String) - Constructor for class org.apache.commons.digester.SetNextRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetNextRule(String methodName)
instead. - SetNextRule(Digester, String, String) - Constructor for class org.apache.commons.digester.SetNextRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetNextRule(String methodName,String paramType)
instead. - SetNextRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetNextRuleFactory
- SetNextRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
SetNextRule
. - SetNextRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.SetNextRuleProvider
- setPluginClassAttribute(String, String) - Method in class org.apache.commons.digester.plugins.PluginContext
-
Sets the xml attribute which the input xml uses to indicate to a PluginCreateRule which class should be instantiated.
- setPluginClassAttribute(String, String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Sets the xml attribute which the input xml uses to indicate to a PluginCreateRule which class should be instantiated.
- setPluginClassAttribute(String, String) - Method in class org.apache.commons.digester.plugins.PluginRules
- setPluginIdAttribute(String, String) - Method in class org.apache.commons.digester.plugins.PluginContext
-
Sets the xml attribute which the input xml uses to indicate to a PluginCreateRule which plugin declaration is being referenced.
- setPluginIdAttribute(String, String) - Method in class org.apache.commons.digester.plugins.PluginCreateRule
-
Sets the xml attribute which the input xml uses to indicate to a PluginCreateRule which plugin declaration is being referenced.
- setPluginIdAttribute(String, String) - Method in class org.apache.commons.digester.plugins.PluginRules
- setProperties(Properties) - Method in class org.apache.commons.digester.plugins.Declaration
-
Copy all (key,value) pairs in the param into the properties member of this object.
- SetPropertiesAliasRule() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetPropertiesAliasRule
-
Base constructor.
- SetPropertiesLoaderHandler - Class in org.apache.commons.digester.annotations.handlers
-
Handler that takes care to create the
SetPropertiesRuleProvider
. - SetPropertiesLoaderHandler() - Constructor for class org.apache.commons.digester.annotations.handlers.SetPropertiesLoaderHandler
- SetPropertiesRule - Class in org.apache.commons.digester
-
Rule implementation that sets properties on the object at the top of the stack, based on attributes with corresponding names.
- SetPropertiesRule() - Constructor for class org.apache.commons.digester.SetPropertiesRule
-
Base constructor.
- SetPropertiesRule(String[], String[]) - Constructor for class org.apache.commons.digester.SetPropertiesRule
-
Constructor allows attribute->property mapping to be overriden.
- SetPropertiesRule(String, String) - Constructor for class org.apache.commons.digester.SetPropertiesRule
-
Convenience constructor overrides the mapping for just one property.
- SetPropertiesRule(Digester) - Constructor for class org.apache.commons.digester.SetPropertiesRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetPropertiesRule()
instead. - SetPropertiesRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetPropertiesRuleFactory
- SetPropertiesRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
SetPropertiesRule
. - SetPropertiesRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider
- setProperty(String, Object) - Method in class org.apache.commons.digester.Digester
-
Set the current value of the specified property for the underlying
XMLReader
implementation. - SetProperty - Annotation Type in org.apache.commons.digester.annotations.rules
-
Fields annotated with
SetProperty
will be bound withSetPropertiesRule
digester rule. - SetProperty.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@SetProperty
annotations on the same element. - SetPropertyRule - Class in org.apache.commons.digester
-
Rule implementation that sets an individual property on the object at the top of the stack, based on attributes with specified names.
- SetPropertyRule(String, String) - Constructor for class org.apache.commons.digester.SetPropertyRule
-
Construct a "set property" rule with the specified name and value attributes.
- SetPropertyRule(Digester, String, String) - Constructor for class org.apache.commons.digester.SetPropertyRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetPropertyRule(String name, String value)
instead. - SetPropertyRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetPropertyRuleFactory
- setPublicId(String) - Method in class org.apache.commons.digester.Digester
-
Set the publid id of the current file being parse.
- setRegexMatcher(RegexMatcher) - Method in class org.apache.commons.digester.RegexRules
-
Sets the current regex matching strategy.
- SetRoot - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods annotated with
SetRoot
will be bound withSetRootRule
digester rule. - SetRootRule - Class in org.apache.commons.digester
-
Rule implementation that calls a method on the root object on the stack, passing the top object (child) as an argument.
- SetRootRule(String) - Constructor for class org.apache.commons.digester.SetRootRule
-
Construct a "set root" rule with the specified method name.
- SetRootRule(String, String) - Constructor for class org.apache.commons.digester.SetRootRule
-
Construct a "set root" rule with the specified method name.
- SetRootRule(Digester, String) - Constructor for class org.apache.commons.digester.SetRootRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetRootRule(String methodName)
instead. - SetRootRule(Digester, String, String) - Constructor for class org.apache.commons.digester.SetRootRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetRootRule(String methodName,String paramType)
instead. - SetRootRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetRootRuleFactory
- SetRootRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
SetRootRule
. - SetRootRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.SetRootRuleProvider
- setRuleFinders(List<RuleFinder>) - Method in class org.apache.commons.digester.plugins.PluginContext
-
Set the list of RuleFinder objects.
- setRuleFinders(List<RuleFinder>) - Method in class org.apache.commons.digester.plugins.PluginRules
- setRuleNamespaceURI(String) - Method in class org.apache.commons.digester.Digester
-
Set the namespace URI that will be applied to all subsequently added
Rule
objects. - setRules(Rules) - Method in class org.apache.commons.digester.Digester
-
Set the
Rules
implementation object containing our rules collection and associated matching policy. - setRulesFactory(RulesFactory) - Method in class org.apache.commons.digester.plugins.PluginRules
-
Set the object which is used to generate the new Rules instances created to hold and process the rules associated with each plugged-in class.
- setSAXLogger(Log) - Method in class org.apache.commons.digester.Digester
-
Sets the logger used for logging SAX-related information.
- setSchema(String) - Method in class org.apache.commons.digester.Digester
-
Deprecated.Use
Schema
for validation instead. - setSchemaLanguage(String) - Method in class org.apache.commons.digester.Digester
-
Deprecated.Use
Schema
for validation instead. - setStackAction(StackAction) - Method in class org.apache.commons.digester.Digester
-
Define a callback object which is invoked whever an object is pushed onto a digester object stack, or popped off one.
- setSubstitutor(Substitutor) - Method in class org.apache.commons.digester.Digester
-
Sets the
Substitutor
to be used to convert attributes and body text. - setTarget(Digester) - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
Sets the digester into which to add the parsed rules
- SetTop - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods annotated with
SetTop
will be bound withSetTopRule
digester rule. - SetTop.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
@SetTop
annotations on the same element - SetTopRule - Class in org.apache.commons.digester
-
Rule implementation that calls a "set parent" method on the top (child) object, passing the (top-1) (parent) object as an argument.
- SetTopRule(String) - Constructor for class org.apache.commons.digester.SetTopRule
-
Construct a "set parent" rule with the specified method name.
- SetTopRule(String, String) - Constructor for class org.apache.commons.digester.SetTopRule
-
Construct a "set parent" rule with the specified method name.
- SetTopRule(Digester, String) - Constructor for class org.apache.commons.digester.SetTopRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetTopRule(String methodName)
instead. - SetTopRule(Digester, String, String) - Constructor for class org.apache.commons.digester.SetTopRule
-
Deprecated.The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseSetTopRule(String methodName, String paramType)
instead. - SetTopRuleFactory() - Constructor for class org.apache.commons.digester.xmlrules.DigesterRuleParser.SetTopRuleFactory
- SetTopRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
SetTopRule
. - SetTopRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.SetTopRuleProvider
- setTrimData(boolean) - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
When set to true, any text within child elements will have leading and trailing whitespace removed before assignment to the target object.
- setUseContextClassLoader(boolean) - Method in class org.apache.commons.digester.Digester
-
Determine whether to use the Context ClassLoader (the one found by calling
Thread.currentThread().getContextClassLoader()
) to resolve/load classes that are defined in various rules. - setUseExactMatch(boolean) - Method in class org.apache.commons.digester.CallMethodRule
-
Set whether
MethodUtils.invokeExactMethod
should be used for the reflection. - setValidating(boolean) - Method in class org.apache.commons.digester.Digester
-
Set the validating parser flag.
- setXIncludeAware(boolean) - Method in class org.apache.commons.digester.Digester
-
Set the XInclude-aware flag for parsers we create.
- setXMLSchema(Schema) - Method in class org.apache.commons.digester.Digester
-
Set the XML Schema to be used when parsing.
- SimpleRegexMatcher - Class in org.apache.commons.digester
-
Simple regex pattern matching algorithm.
- SimpleRegexMatcher() - Constructor for class org.apache.commons.digester.SimpleRegexMatcher
- skippedEntity(String) - Method in class org.apache.commons.digester.Digester
-
Process notification of a skipped entity.
- sources - Variable in class org.apache.commons.digester.substitution.MultiVariableExpander
- stack - Variable in class org.apache.commons.digester.Digester
-
The object stack being constructed.
- stackAction - Variable in class org.apache.commons.digester.Digester
-
Object which will receive callbacks for every pop/push action on the default stack or named stacks.
- StackAction - Interface in org.apache.commons.digester
-
An interface that can be implemented in order to get notifications of objects being pushed onto a digester stack or popped from one.
- StackCallParam - Annotation Type in org.apache.commons.digester.annotations.rules
-
Methods arguments annotated with
StackCallParam
will be bound withCallParamRule
digester rule. - StackCallParam.List - Annotation Type in org.apache.commons.digester.annotations.rules
-
Defines several
StackCallParam
annotations on the same element. - StackCallParamRuleProvider - Class in org.apache.commons.digester.annotations.providers
-
Provides instances of
CallParamRule
. - StackCallParamRuleProvider() - Constructor for class org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider
- stackIndex - Variable in class org.apache.commons.digester.annotations.providers.StackCallParamRuleProvider
- stackIndex - Variable in class org.apache.commons.digester.CallParamRule
-
The position of the object from the top of the stack
- stackIndex() - Element in annotation type org.apache.commons.digester.annotations.rules.StackCallParam
-
The call parameter to the stackIndex'th object down the stack, where 0 is the top of the stack, 1 the next element down and so on.
- stacksByName - Variable in class org.apache.commons.digester.Digester
-
Stacks used for interrule communication, indexed by name String
- startDocument() - Method in class org.apache.commons.digester.Digester
-
Process notification of the beginning of the document being reached.
- startElement(String, String, String, Attributes) - Method in class org.apache.commons.digester.Digester
-
Process notification of the start of an XML element being reached.
- startElement(String, String, String, Attributes) - Method in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
Adds a new child
Element
to the current node. - startPrefixMapping(String, String) - Method in class org.apache.commons.digester.Digester
-
Process notification that a namespace prefix is coming in to scope.
- substitute(String) - Method in class org.apache.commons.digester.substitution.VariableSubstitutor
-
Substitutes for the body text.
- substitute(String) - Method in class org.apache.commons.digester.Substitutor
-
Substitutes for the body text.
- substitute(Attributes) - Method in class org.apache.commons.digester.substitution.VariableSubstitutor
-
Substitutes the attributes (before they are passed to the
Rule
implementations's) - substitute(Attributes) - Method in class org.apache.commons.digester.Substitutor
-
Substitutes the attributes (before they are passed to the
Rule
implementations's). - substitutor - Variable in class org.apache.commons.digester.Digester
-
An optional class that substitutes values in attributes and body text.
- Substitutor - Class in org.apache.commons.digester
-
(Logical) Interface for substitution strategies.
- Substitutor() - Constructor for class org.apache.commons.digester.Substitutor
- SUPPORTED_ARGS - Static variable in class org.apache.commons.digester.annotations.handlers.MethodHandler
-
The default args size the method has to have in order to be analyzed.
T
- targetDigester - Variable in class org.apache.commons.digester.xmlrules.DigesterRuleParser
-
This is the digester to which we are adding the rules that we parse from the Rules XML document.
- targetOffset - Variable in class org.apache.commons.digester.CallMethodRule
-
location of the target object for the call, relative to the top of the digester object stack.
- top - Variable in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
The current top DOM mode.
- topText - Variable in class org.apache.commons.digester.NodeCreateRule.NodeBuilder
-
The text content of the current top DOM node.
- toString() - Method in class org.apache.commons.digester.annotations.FromAnnotationsRuleSet
- toString() - Method in class org.apache.commons.digester.BeanPropertySetterRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.CallMethodRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.CallParamRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.FactoryCreateRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.ObjectCreateRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.ObjectParamRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.PathCallParamRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.SetNestedPropertiesRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.SetNextRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.SetPropertiesRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.SetPropertyRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.SetRootRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.SetTopRule
-
Render a printable version of this Rule.
- toString() - Method in class org.apache.commons.digester.xmlrules.DigesterRuleParser.PatternStack
- trimData - Variable in class org.apache.commons.digester.SetNestedPropertiesRule
U
- unparsedEntityDecl(String, String, String, String) - Method in class org.apache.commons.digester.Digester
-
Receive notification of an unparsed entity declaration event.
- url - Variable in class org.apache.commons.digester.xmlrules.FromXmlRuleSet.URLXMLRulesLoader
- URLXMLRulesLoader(URL) - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet.URLXMLRulesLoader
- useAnnotationRuleProviderFactory(AnnotationRuleProviderFactory) - Method in class org.apache.commons.digester.annotations.DigesterLoaderBuilder
-
Builds a new
DigesterLoader
using the user definedAnnotationRuleProviderFactory
implementation. - useContextClassLoader - Variable in class org.apache.commons.digester.Digester
-
Do we want to use the Context ClassLoader when loading classes for instantiating new objects.
- useDefaultAnnotationRuleProviderFactory() - Method in class org.apache.commons.digester.annotations.DigesterLoaderBuilder
-
Builds a new
DigesterLoader
using the defaultAnnotationRuleProviderFactory
implementation. - useDefaultDigesterLoaderHandlerFactory() - Method in class org.apache.commons.digester.annotations.FromAnnotationRuleProviderFactory
-
Builds a new
DigesterLoader
using the defaultDigesterLoaderHandlerFactory
implementation. - useDigesterLoaderHandlerFactory(DigesterLoaderHandlerFactory) - Method in class org.apache.commons.digester.annotations.FromAnnotationRuleProviderFactory
-
Builds a new
DigesterLoader
using the user definedDigesterLoaderHandlerFactory
implementation. - useExactMatch - Variable in class org.apache.commons.digester.CallMethodRule
-
Should
MethodUtils.invokeExactMethod
be used for reflection. - useExactMatch - Variable in class org.apache.commons.digester.SetNextRule
-
Should we use exact matching.
- useExactMatch - Variable in class org.apache.commons.digester.SetRootRule
-
Should we use exact matching.
- useExactMatch - Variable in class org.apache.commons.digester.SetTopRule
-
Should we use exact matching.
V
- validating - Variable in class org.apache.commons.digester.Digester
-
Do we want to use a validating parser.
- value - Variable in class org.apache.commons.digester.SetPropertyRule
-
The attribute that will contain the property value.
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.AttributeCallParam.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.BeanPropertySetter.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.CallMethod.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.CallParam.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.FactoryCreate.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.ObjectCreate.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.PathCallParam.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.SetNext
-
Defines the concrete implementation(s) of @SetNext annotated method argument.
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.SetProperty.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.SetRoot
-
Defines the concrete implementation(s) of @SetRoot annotated method argument.
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.SetTop.List
- value() - Element in annotation type org.apache.commons.digester.annotations.rules.StackCallParam.List
- VALUE - Static variable in class org.apache.commons.digester.annotations.utils.AnnotationUtils
-
The
value
string constant. - values - Variable in class org.apache.commons.digester.substitution.VariableAttributes
- variableAttributes - Variable in class org.apache.commons.digester.substitution.VariableSubstitutor
-
Attributes implementation that (lazily) performs variable substitution.
- VariableAttributes - Class in org.apache.commons.digester.substitution
-
Wrapper for an org.xml.sax.Attributes object which expands any "variables" referenced in the attribute value via ${foo} or similar.
- VariableAttributes() - Constructor for class org.apache.commons.digester.substitution.VariableAttributes
- VariableExpander - Interface in org.apache.commons.digester.substitution
-
An Interface describing a class capable of expanding strings which may contain variable references.
- VariableSubstitutor - Class in org.apache.commons.digester.substitution
-
Substitutor implementation that support variable replacement for both attributes and body text.
- VariableSubstitutor(VariableExpander) - Constructor for class org.apache.commons.digester.substitution.VariableSubstitutor
-
Constructs a Substitutor which uses the same VariableExpander for both body text and attibutes.
- VariableSubstitutor(VariableExpander, VariableExpander) - Constructor for class org.apache.commons.digester.substitution.VariableSubstitutor
-
Constructs a Substitutor.
- version - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.A
float
representing the underlying Xerces version - versionNumber - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.The current Xerces version.
W
- W3C_XML_SCHEMA - Static variable in class org.apache.commons.digester.Digester
-
The schema language supported.
- warning(SAXParseException) - Method in class org.apache.commons.digester.Digester
-
Forward notification of a parse warning to the application supplied error handler (if any).
- WithDefaultsRulesWrapper - Class in org.apache.commons.digester
-
Rules
Decorator that returns default rules when no matches are returned by the wrapped implementation. - WithDefaultsRulesWrapper(Rules) - Constructor for class org.apache.commons.digester.WithDefaultsRulesWrapper
-
Base constructor.
- wrappedRules - Variable in class org.apache.commons.digester.WithDefaultsRulesWrapper
-
The Rules implementation that this class wraps.
X
- XERCES_DYNAMIC - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.Xerces dynamic validation property
- XERCES_SCHEMA - Static variable in class org.apache.commons.digester.parser.XercesParser
-
Deprecated.Xerces schema validation property
- XercesParser - Class in org.apache.commons.digester.parser
-
Deprecated.Create an XMLParser instance yourself, configure validation appropriately, and pass it as a parameter to the
Digester
constructor, or useDigester.setXMLSchema(javax.xml.validation.Schema)
for validation. - XercesParser() - Constructor for class org.apache.commons.digester.parser.XercesParser
-
Deprecated.
- xincludeAware - Variable in class org.apache.commons.digester.Digester
-
Do we want a "XInclude aware" parser.
- XmlLoadException - Exception in org.apache.commons.digester.xmlrules
-
Thrown when an error occurs while parsing XML into Digester rules.
- XmlLoadException(String) - Constructor for exception org.apache.commons.digester.xmlrules.XmlLoadException
- XmlLoadException(String, Throwable) - Constructor for exception org.apache.commons.digester.xmlrules.XmlLoadException
- XmlLoadException(Throwable) - Constructor for exception org.apache.commons.digester.xmlrules.XmlLoadException
- XMLRulesLoader() - Constructor for class org.apache.commons.digester.xmlrules.FromXmlRuleSet.XMLRulesLoader
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method. UseBeanPropertySetterRule()
instead.