A B C D E F G H I L M N O P R S T U V W

A

AbstractMethodRule - Class in org.apache.commons.digester3
Abstract implementation for SetNextRule, SetRootRule and SetTopRule rules.
AbstractMethodRule(String) - Constructor for class org.apache.commons.digester3.AbstractMethodRule
Construct a "set next" rule with the specified method name.
AbstractMethodRule(String, Class<?>) - Constructor for class org.apache.commons.digester3.AbstractMethodRule
Construct a "set next" rule with the specified method name.
AbstractMethodRule(String, String) - Constructor for class org.apache.commons.digester3.AbstractMethodRule
Construct a "set next" rule with the specified method name.
AbstractNamespaceURIBasedRulesModule - Class in org.apache.commons.digester3.binder
A support class for RulesModule which reduces repetition and results in a more readable configuration, that sets rules binding for a defined namespace URI (it can be overridden while binding).
AbstractNamespaceURIBasedRulesModule(String) - Constructor for class org.apache.commons.digester3.binder.AbstractNamespaceURIBasedRulesModule
Creates a new (nullable) namespaceURI-based RulesModule that automatically binds every rule to the input namespaceURI.
AbstractObjectCreationFactory<T> - Class in org.apache.commons.digester3
Abstract base class for ObjectCreationFactory implementations.
AbstractObjectCreationFactory() - Constructor for class org.apache.commons.digester3.AbstractObjectCreationFactory
 
AbstractParamTypeBuilder<R extends AbstractMethodRule> - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setNext(String), LinkedRuleBuilder.setRoot(String) or LinkedRuleBuilder.setTop(String).
AbstractRulesImpl - Class in org.apache.commons.digester3
AbstractRuleImpl provides basic services for Rules implementations.
AbstractRulesImpl() - Constructor for class org.apache.commons.digester3.AbstractRulesImpl
 
AbstractRulesModule - Class in org.apache.commons.digester3.binder
A support class for RulesModule which reduces repetition and results in a more readable configuration.
AbstractRulesModule() - Constructor for class org.apache.commons.digester3.binder.AbstractRulesModule
 
add(String, Rule) - Method in class org.apache.commons.digester3.AbstractRulesImpl
Register a new Rule instance matching the specified pattern.
add(String, Rule) - Method in class org.apache.commons.digester3.plugins.PluginRules
Register a new Rule instance matching the specified pattern.
add(String, Rule) - Method in interface org.apache.commons.digester3.Rules
Register a new Rule instance matching the specified pattern.
add(String, Rule) - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Register a new Rule instance matching the specified pattern.
addAlias(String, String) - Method in class org.apache.commons.digester3.binder.NestedPropertiesBuilder
Allows element2property mapping to be overridden.
addAlias(String, String) - Method in class org.apache.commons.digester3.binder.SetPropertiesBuilder
Add an additional attribute name to property name mapping.
addAlias(String, String) - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
Add an additional custom xml-element -> property mapping.
addAlias(String, String) - Method in class org.apache.commons.digester3.SetPropertiesRule
Add an additional attribute name to property name mapping.
addBeanPropertySetter(String) - Method in class org.apache.commons.digester3.Digester
Add a "bean property setter" rule for the specified parameters.
addBeanPropertySetter(String, String) - Method in class org.apache.commons.digester3.Digester
Add a "bean property setter" rule for the specified parameters.
addCallMethod(String, String) - Method in class org.apache.commons.digester3.Digester
Add an "call method" rule for a method which accepts no arguments.
addCallMethod(String, String, int) - Method in class org.apache.commons.digester3.Digester
Add an "call method" rule for the specified parameters.
addCallMethod(String, String, int, String[]) - Method in class org.apache.commons.digester3.Digester
Add an "call method" rule for the specified parameters.
addCallMethod(String, String, int, Class<?>[]) - Method in class org.apache.commons.digester3.Digester
Add an "call method" rule for the specified parameters.
addCallParam(String, int) - Method in class org.apache.commons.digester3.Digester
Add a "call parameter" rule for the specified parameters.
addCallParam(String, int, String) - Method in class org.apache.commons.digester3.Digester
Add a "call parameter" rule for the specified parameters.
addCallParam(String, int, boolean) - Method in class org.apache.commons.digester3.Digester
Add a "call parameter" rule.
addCallParam(String, int, int) - Method in class org.apache.commons.digester3.Digester
Add a "call parameter" rule that sets a parameter from the stack.
addCallParamPath(String, int) - Method in class org.apache.commons.digester3.Digester
Add a "call parameter" rule that sets a parameter from the current Digester matching path.
addDeclaration(Declaration) - Method in class org.apache.commons.digester3.plugins.PluginManager
Add the declaration to the set of known declarations.
addDefault(Rule) - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Adds a rule to be fired when wrapped implementation returns no matches
addError(String, Object...) - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Records an error message which will be presented to the user at a later time.
addError(Throwable) - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Records an exception, the full details of which will be logged, and the message of which will be presented to the user at a later time.
addError(String, Object...) - Method in interface org.apache.commons.digester3.binder.RulesBinder
Records an error message which will be presented to the user at a later time.
addError(Throwable) - Method in interface org.apache.commons.digester3.binder.RulesBinder
Records an exception, the full details of which will be logged, and the message of which will be presented to the user at a later time.
addFactoryCreate(String, String) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, Class<? extends ObjectCreationFactory<?>>) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, Class<? extends ObjectCreationFactory<?>>, String) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, ObjectCreationFactory<?>) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, String, boolean) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, Class<? extends ObjectCreationFactory<?>>, boolean) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, String, String, boolean) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, Class<? extends ObjectCreationFactory<?>>, String, boolean) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addFactoryCreate(String, ObjectCreationFactory<?>, boolean) - Method in class org.apache.commons.digester3.Digester
Add a "factory create" rule for the specified parameters.
addObjectCreate(String, String) - Method in class org.apache.commons.digester3.Digester
Add an "object create" rule for the specified parameters.
addObjectCreate(String, Class<?>) - Method in class org.apache.commons.digester3.Digester
Add an "object create" rule for the specified parameters.
addObjectCreate(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add an "object create" rule for the specified parameters.
addObjectCreate(String, String, Class<?>) - Method in class org.apache.commons.digester3.Digester
Add an "object create" rule for the specified parameters.
addObjectParam(String, int, Object) - Method in class org.apache.commons.digester3.Digester
Add a "call parameter" rule that sets a parameter from a caller-provided object.
addRule(R) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Add a custom user rule in the specified pattern.
addRule(String, Rule) - Method in class org.apache.commons.digester3.Digester
Register a new Rule matching the specified pattern.
addRuleCreatedBy(RuleProvider<R>) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Add a custom user rule in the specified pattern built by the given provider.
addRuleInstances(Digester) - Method in interface org.apache.commons.digester3.RuleSet
Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
addRules(Digester) - Method in class org.apache.commons.digester3.binder.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.digester3.plugins.RuleLoader
Configures the digester with custom rules for some plugged-in class.
addRules(Digester, String) - Method in class org.apache.commons.digester3.plugins.strategies.LoaderFromClass
Configures the digester with custom rules for some plugged-in class.
addRules(Digester, String) - Method in class org.apache.commons.digester3.plugins.strategies.LoaderFromStream
Configures the digester with custom rules for some plugged-in class.
addRules(Digester, String) - Method in class org.apache.commons.digester3.plugins.strategies.LoaderSetProperties
Configures the digester with custom rules for some plugged-in class.
addRuleSet(RuleSet) - Method in class org.apache.commons.digester3.Digester
Register a set of Rule instances defined in a RuleSet.
addSetNestedProperties(String) - Method in class org.apache.commons.digester3.Digester
Adds an SetNestedPropertiesRule.
addSetNestedProperties(String, String, String) - Method in class org.apache.commons.digester3.Digester
Adds an SetNestedPropertiesRule.
addSetNestedProperties(String, String[], String[]) - Method in class org.apache.commons.digester3.Digester
Adds an SetNestedPropertiesRule.
addSetNext(String, String) - Method in class org.apache.commons.digester3.Digester
Add a "set next" rule for the specified parameters.
addSetNext(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add a "set next" rule for the specified parameters.
addSetProperties(String) - Method in class org.apache.commons.digester3.Digester
Add a "set properties" rule for the specified parameters.
addSetProperties(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add a "set properties" rule with a single overridden parameter.
addSetProperties(String, String[], String[]) - Method in class org.apache.commons.digester3.Digester
Add a "set properties" rule with overridden parameters.
addSetProperty(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add a "set property" rule for the specified parameters.
addSetRoot(String, String) - Method in class org.apache.commons.digester3.Digester
Add SetRootRule with the specified parameters.
addSetRoot(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add SetRootRule with the specified parameters.
addSetTop(String, String) - Method in class org.apache.commons.digester3.Digester
Add a "set top" rule for the specified parameters.
addSetTop(String, String, String) - Method in class org.apache.commons.digester3.Digester
Add a "set top" rule for the specified parameters.
addSource(String, Map<String, Object>) - Method in class org.apache.commons.digester3.substitution.MultiVariableExpander
Add a new variables source, identified by the input marker
allowUnknownChildElements(boolean) - Method in class org.apache.commons.digester3.binder.NestedPropertiesBuilder
Determines whether an error is reported when a nested element is encountered for which there is no corresponding property-setter method.
AnnotationHandler<A extends Annotation,E extends AnnotatedElement> - Interface in org.apache.commons.digester3.annotations
Intercepts a Class visit performed by the DigesterLoader.
AnnotationHandlerFactory - Interface in org.apache.commons.digester3.annotations
An object capable of providing instances of AnnotationHandler.
AnnotationUtils - Class in org.apache.commons.digester3.annotations.utils
Simple utility class to introspect annotations.
asyncParse(File) - Method in class org.apache.commons.digester3.Digester
Creates a Callable instance that parse the content of the specified reader using this Digester.
asyncParse(InputSource) - Method in class org.apache.commons.digester3.Digester
Creates a Callable instance that parse the content of the specified reader using this Digester.
asyncParse(InputStream) - Method in class org.apache.commons.digester3.Digester
Creates a Callable instance that parse the content of the specified reader using this Digester.
asyncParse(Reader) - Method in class org.apache.commons.digester3.Digester
Creates a Callable instance that parse the content of the specified reader using this Digester.
asyncParse(String) - Method in class org.apache.commons.digester3.Digester
Creates a Callable instance that parse the content of the specified reader using this Digester.
asyncParse(URL) - Method in class org.apache.commons.digester3.Digester
Creates a Callable instance that parse the content of the specified reader using this Digester.
attributeName - Variable in class org.apache.commons.digester3.CallParamRule
The attribute from which to save the parameter value
attributeName - Variable in class org.apache.commons.digester3.FactoryCreateRule
The attribute containing an override class name if it is present.
attributeName - Variable in class org.apache.commons.digester3.ObjectCreateRule
The attribute containing an override class name if it is present.
attributeName - Variable in class org.apache.commons.digester3.ObjectParamRule
The attribute which we are attempting to match

B

BeanPropertySetter - Annotation Type in org.apache.commons.digester3.annotations.rules
Fields annotated with BeanPropertySetter will be bound with BeanPropertySetterRule digester rule.
BeanPropertySetter.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @BeanPropertySetter annotations on the same element.
BeanPropertySetterBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setBeanProperty().
BeanPropertySetterHandler - Class in org.apache.commons.digester3.annotations.handlers
BeanPropertySetter handler.
BeanPropertySetterHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.BeanPropertySetterHandler
 
BeanPropertySetterRule - Class in org.apache.commons.digester3
Rule implements sets a bean property on the top object to the body text.
BeanPropertySetterRule(String) - Constructor for class org.apache.commons.digester3.BeanPropertySetterRule
Construct rule that sets the given property from the body text.
BeanPropertySetterRule() - Constructor for class org.apache.commons.digester3.BeanPropertySetterRule
Construct rule that automatically sets a property from the body text.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.AbstractMethodRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.BeanPropertySetterRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.CallMethodRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.CallParamRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.FactoryCreateRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.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.digester3.ObjectCreateRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.ObjectParamRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.PathCallParamRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.plugins.PluginCreateRule
Invoked when the Digester matches this rule against an xml element.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.plugins.PluginDeclarationRule
Invoked upon reading a tag defining a plugin declaration.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.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.digester3.SetNestedPropertiesRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.SetPropertiesRule
This method is called when the beginning of a matching XML element is encountered.
begin(String, String, Attributes) - Method in class org.apache.commons.digester3.SetPropertyRule
This method is called when the beginning of a matching XML element is encountered.
bindRulesFrom(Class<?>) - Method in class org.apache.commons.digester3.annotations.FromAnnotationsRuleModule
Scan the input Class, looking for Digester rules expressed via annotations, and binds them.
body(String, String, String) - Method in class org.apache.commons.digester3.BeanPropertySetterRule
This method is called when the body of a matching XML element is encountered.
body(String, String, String) - Method in class org.apache.commons.digester3.CallMethodRule
This method is called when the body of a matching XML element is encountered.
body(String, String, String) - Method in class org.apache.commons.digester3.CallParamRule
This method is called when the body of a matching XML element is encountered.
body(String, String, String) - Method in class org.apache.commons.digester3.plugins.PluginCreateRule
This method is called when the body of a matching XML element is encountered.
body(String, String, String) - Method in class org.apache.commons.digester3.Rule
This method is called when the body of a matching XML element is encountered.
body(String, String, String) - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
This method is called when the body of a matching XML element is encountered.
bodyText - Variable in class org.apache.commons.digester3.CallMethodRule
The body text collected from this element.
bodyTextStack - Variable in class org.apache.commons.digester3.CallParamRule
Stack is used to allow nested body text to be processed.
ByRuleBuilder<R extends Rule> - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.addRule(Rule).
ByRuleProviderBuilder<R extends Rule> - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.addRuleCreatedBy(org.apache.commons.digester3.binder.RuleProvider).

C

cache - Variable in class org.apache.commons.digester3.RulesBase
The set of registered Rule instances, keyed by the matching pattern.
CallMethod - Annotation Type in org.apache.commons.digester3.annotations.rules
Methods annotated with CallMethod will be bound with CallMethodRule digester rule.
callMethod(String) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Calls a method on an object on the stack (normally the top/parent object), passing arguments collected from subsequent LinkedRuleBuilder.callParam() rule or from the body of this element.
CallMethod.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @CallMethod annotations on the same element.
CallMethodBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.callMethod(String).
CallMethodHandler - Class in org.apache.commons.digester3.annotations.handlers
CallMethod handler.
CallMethodHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.CallMethodHandler
 
CallMethodRule - Class in org.apache.commons.digester3
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(String, int) - Constructor for class org.apache.commons.digester3.CallMethodRule
Construct a "call method" rule with the specified method name.
CallMethodRule(int, String, int) - Constructor for class org.apache.commons.digester3.CallMethodRule
Construct a "call method" rule with the specified method name.
CallMethodRule(String) - Constructor for class org.apache.commons.digester3.CallMethodRule
Construct a "call method" rule with the specified method name.
CallMethodRule(int, String) - Constructor for class org.apache.commons.digester3.CallMethodRule
Construct a "call method" rule with the specified method name.
CallMethodRule(String, int, String[]) - Constructor for class org.apache.commons.digester3.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.digester3.CallMethodRule
Construct a "call method" rule with the specified method name and parameter types.
CallMethodRule(String, int, Class<?>[]) - Constructor for class org.apache.commons.digester3.CallMethodRule
Construct a "call method" rule with the specified method name and parameter types.
CallMethodRule(int, String, int, Class<?>[]) - Constructor for class org.apache.commons.digester3.CallMethodRule
Construct a "call method" rule with the specified method name and parameter types.
CallParam - Annotation Type in org.apache.commons.digester3.annotations.rules
Methods arguments annotated with CallParam will be bound with CallParamRule digester rule.
callParam() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Saves a parameter for use by a surrounding LinkedRuleBuilder.callMethod(String).
CallParam.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @CallParam annotations on the same element.
CallParamBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.callParam().
CallParamHandler - Class in org.apache.commons.digester3.annotations.handlers
CallParam handler.
CallParamHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.CallParamHandler
 
callParamPath() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Construct a "call parameter" rule that will save the body text of this element as the parameter value.
CallParamRule - Class in org.apache.commons.digester3
Rule implementation that saves a parameter for use by a surrounding CallMethodRule.
CallParamRule(int) - Constructor for class org.apache.commons.digester3.CallParamRule
Construct a "call parameter" rule that will save the body text of this element as the parameter value.
CallParamRule(int, String) - Constructor for class org.apache.commons.digester3.CallParamRule
Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
CallParamRule(int, boolean) - Constructor for class org.apache.commons.digester3.CallParamRule
Construct a "call parameter" rule.
CallParamRule(int, int) - Constructor for class org.apache.commons.digester3.CallParamRule
Constructs a "call parameter" rule which sets a parameter from the stack.
characters(char[], int, int) - Method in class org.apache.commons.digester3.Digester
className - Variable in class org.apache.commons.digester3.FactoryCreateRule
The Java class name of the ObjectCreationFactory to be created.
className - Variable in class org.apache.commons.digester3.ObjectCreateRule
The Java class name of the object to be created.
clazz - Variable in class org.apache.commons.digester3.ObjectCreateRule
The Java class of the object to be created.
cleanup() - Method in class org.apache.commons.digester3.Digester
Clean up allocated resources after parsing is complete.
clear() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginRules
Clear all rules.
clear() - Method in class org.apache.commons.digester3.RegexRules
Clear all existing Rule instance registrations.
clear() - Method in interface org.apache.commons.digester3.Rules
Clear all existing Rule instance registrations.
clear() - Method in class org.apache.commons.digester3.RulesBase
Clear all existing Rule instance registrations.
clear() - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Clear all existing Rule instance registrations.
CompoundSubstitutor - Class in org.apache.commons.digester3.substitution
This Substitutor chains two Substitutors a and b.
CompoundSubstitutor(Substitutor, Substitutor) - Constructor for class org.apache.commons.digester3.substitution.CompoundSubstitutor
Creates a new CompoundSubstitutor instance.
configure() - Method in class org.apache.commons.digester3.annotations.FromAnnotationsRuleModule
Configures a RulesBinder via the exposed methods.
configure(RulesBinder) - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Configure the Digester rules binding via the given rules binder.
configure() - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Configures a RulesBinder via the exposed methods.
configure(RulesBinder) - Method in interface org.apache.commons.digester3.binder.RulesModule
Configure the Digester rules binding via the given rules binder.
configure() - Method in class org.apache.commons.digester3.Digester
Provide a hook for lazy configuration of this Digester instance.
configure(Digester, String) - Method in class org.apache.commons.digester3.plugins.Declaration
Attempt to load custom rules for the target class at the specified pattern.
configure() - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Configures a RulesBinder via the exposed methods.
configureRules() - Method in class org.apache.commons.digester3.annotations.FromAnnotationsRuleModule
Configures a RulesBinder via the exposed methods.
createInputSourceFromURL(URL) - Method in class org.apache.commons.digester3.Digester
Given a URL, return an InputSource that reads from that URL.
createInputSourceFromURL(String) - Method in class org.apache.commons.digester3.Digester
Convenience method that creates an InputSource from the string version of a URL.
createNode() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
A rule implementation that creates a DOM Node containing the XML at the element that matched the rule.
createObject(Attributes) - Method in class org.apache.commons.digester3.AbstractObjectCreationFactory
Factory method called by FactoryCreateRule to supply an object based on the element's attributes.
createObject(Attributes) - Method in class org.apache.commons.digester3.annotations.rules.FactoryCreate.DefaultObjectCreationFactory
Factory method called by FactoryCreateRule to supply an object based on the element's attributes.
createObject() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Construct an object.
createObject(Attributes) - Method in interface org.apache.commons.digester3.ObjectCreationFactory
Factory method called by FactoryCreateRule to supply an object based on the element's attributes.
createPlugin() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
A Digester rule which allows the user to declare a plugin.
createRule() - Method in class org.apache.commons.digester3.binder.BeanPropertySetterBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.ByRuleBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.ByRuleProviderBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.CallParamBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.FactoryCreateBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.NestedPropertiesBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.NodeCreateRuleProvider
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.ObjectCreateBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.ObjectParamBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.PathCallParamBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.PluginCreateRuleBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.PluginDeclarationRuleBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.SetNextBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.SetPropertiesBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.SetPropertyBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.SetRootBuilder
Provides an instance of Rule.
createRule() - Method in class org.apache.commons.digester3.binder.SetTopBuilder
Provides an instance of Rule.
createRuleSet() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new RuleSet instance based on the current configuration.
createSAXException(String, Exception) - Method in class org.apache.commons.digester3.Digester
Create a SAX exception which also understands about the location in the digester file where the exception occurs
createSAXException(Exception) - Method in class org.apache.commons.digester3.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.digester3.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.digester3.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.digester3.annotations.rules
Marks a Digester rule as a creation rule, that's crucial for the setNext rule.

D

Declaration - Class in org.apache.commons.digester3.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(String) - Constructor for class org.apache.commons.digester3.plugins.Declaration
Constructor.
Declaration(Class<?>) - Constructor for class org.apache.commons.digester3.plugins.Declaration
Constructor.
Declaration(Class<?>, RuleLoader) - Constructor for class org.apache.commons.digester3.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.
declarePlugin() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
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.
declarePlugin(Digester, Properties) - Static method in class org.apache.commons.digester3.plugins.PluginDeclarationRule
Helper method to declare a plugin inside the given Digester.
Digester - Class in org.apache.commons.digester3
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.digester3.Digester
Construct a new Digester with default properties.
Digester(SAXParser) - Constructor for class org.apache.commons.digester3.Digester
Construct a new Digester, allowing a SAXParser to be passed in.
Digester(XMLReader) - Constructor for class org.apache.commons.digester3.Digester
Construct a new Digester, allowing an XMLReader to be passed in.
digester - Variable in class org.apache.commons.digester3.plugins.PluginRules
The Digester instance with which this Rules instance is associated.
DigesterLoader - Class in org.apache.commons.digester3.binder
This class manages the creation of Digester instances from digester rules modules.
DigesterLoadingException - Exception in org.apache.commons.digester3.binder
Thrown when errors occur while creating a Digester.
DigesterLoadingException(String, Throwable) - Constructor for exception org.apache.commons.digester3.binder.DigesterLoadingException
Constructs a new exception with the specified detail message and cause.
DigesterLoadingException(String) - Constructor for exception org.apache.commons.digester3.binder.DigesterLoadingException
Constructs a new Digester exception with the specified detail message.
DigesterLoadingException(Throwable) - Constructor for exception org.apache.commons.digester3.binder.DigesterLoadingException
Constructs a new exception with the specified cause.
DigesterRule - Annotation Type in org.apache.commons.digester3.annotations
Meta-annotation that marks an annotation as part of commons-digester.
DigesterRuleList - Annotation Type in org.apache.commons.digester3.annotations
Meta-annotation that marks an annotation as a list of commons-digester annotations.
doBind(String, String, Method, Class<?>, boolean, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.SetNextHandler
doBind(String, String, Method, Class<?>, boolean, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.SetRootHandler

E

end(String, String) - Method in class org.apache.commons.digester3.AbstractMethodRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.BeanPropertySetterRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.CallMethodRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.CallParamRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.FactoryCreateRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.NodeCreateRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.ObjectCreateRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.plugins.PluginCreateRule
This method is called when the end of a matching XML element is encountered.
end(String, String) - Method in class org.apache.commons.digester3.Rule
This method is called when the end of a matching XML element is encountered.
endDocument() - Method in class org.apache.commons.digester3.Digester
endElement(String, String, String) - Method in class org.apache.commons.digester3.Digester
endPrefixMapping(String) - Method in class org.apache.commons.digester3.Digester
error(SAXParseException) - Method in class org.apache.commons.digester3.Digester
expand(String) - Method in class org.apache.commons.digester3.substitution.MultiVariableExpander
Return the input string with any variables replaced by their corresponding value.
expand(String, String, Map<String, Object>) - Method in class org.apache.commons.digester3.substitution.MultiVariableExpander
Replace any occurrences within the string of the form "marker{key}" with the value from source[key].
expand(String) - Method in interface org.apache.commons.digester3.substitution.VariableExpander
Return the input string with any variables replaced by their corresponding value.
ExtendedBaseRules - Class in org.apache.commons.digester3
Extension of RulesBase for complex schema.
ExtendedBaseRules() - Constructor for class org.apache.commons.digester3.ExtendedBaseRules
 
extractingValueFromAttribute(String) - Method in class org.apache.commons.digester3.binder.SetPropertyBuilder
Set the name of the attribute that will contain the value to which the property should be set.
extractPropertyNameFromAttribute(String) - Method in class org.apache.commons.digester3.binder.BeanPropertySetterBuilder
Sets the attribute name from which the property name has to be extracted.

F

FactoryCreate - Annotation Type in org.apache.commons.digester3.annotations.rules
Classes annotated with FactoryCreate will be bound with FactoryCreateRule digester rule.
factoryCreate() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Uses an ObjectCreationFactory to create a new object which it pushes onto the object stack.
FactoryCreate.DefaultObjectCreationFactory - Class in org.apache.commons.digester3.annotations.rules
Dummy ObjectCreationFactory type - only for annotation value type purposes.
FactoryCreate.DefaultObjectCreationFactory() - Constructor for class org.apache.commons.digester3.annotations.rules.FactoryCreate.DefaultObjectCreationFactory
 
FactoryCreate.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @FactoryCreate annotations on the same element.
FactoryCreateBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.factoryCreate().
FactoryCreateHandler - Class in org.apache.commons.digester3.annotations.handlers
FactoryCreate handler.
FactoryCreateHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.FactoryCreateHandler
 
FactoryCreateRule - Class in org.apache.commons.digester3
Rule implementation that uses an ObjectCreationFactory to create a new object which it pushes onto the object stack.
FactoryCreateRule(String) - Constructor for class org.apache.commons.digester3.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(Class<? extends ObjectCreationFactory<?>>) - Constructor for class org.apache.commons.digester3.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(String, String) - Constructor for class org.apache.commons.digester3.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(Class<? extends ObjectCreationFactory<?>>, String) - Constructor for class org.apache.commons.digester3.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(ObjectCreationFactory<?>) - Constructor for class org.apache.commons.digester3.FactoryCreateRule
Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.
FactoryCreateRule(String, boolean) - Constructor for class org.apache.commons.digester3.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(Class<? extends ObjectCreationFactory<?>>, boolean) - Constructor for class org.apache.commons.digester3.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(String, String, boolean) - Constructor for class org.apache.commons.digester3.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(Class<? extends ObjectCreationFactory<?>>, String, boolean) - Constructor for class org.apache.commons.digester3.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(ObjectCreationFactory<?>, boolean) - Constructor for class org.apache.commons.digester3.FactoryCreateRule
Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.
fatalError(SAXParseException) - Method in class org.apache.commons.digester3.Digester
FinderFromClass - Class in org.apache.commons.digester3.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.digester3.plugins.strategies.FinderFromClass
See FinderFromClass.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromClass(String, String, String) - Constructor for class org.apache.commons.digester3.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.digester3.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.digester3.plugins.strategies.FinderFromDfltClass
See FinderFromDfltClass.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromDfltClass(String, String) - Constructor for class org.apache.commons.digester3.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.digester3.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.digester3.plugins.strategies.FinderFromDfltMethod
See FinderFromDfltMethod.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromDfltMethod(String) - Constructor for class org.apache.commons.digester3.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.digester3.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.digester3.plugins.strategies.FinderFromDfltResource
See FinderFromDfltResource.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromDfltResource(String) - Constructor for class org.apache.commons.digester3.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.digester3.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.digester3.plugins.strategies.FinderFromFile
See FinderFromFile.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromFile(String) - Constructor for class org.apache.commons.digester3.plugins.strategies.FinderFromFile
See FinderFromFile.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromMethod - Class in org.apache.commons.digester3.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.digester3.plugins.strategies.FinderFromMethod
Constructor.
FinderFromMethod(String) - Constructor for class org.apache.commons.digester3.plugins.strategies.FinderFromMethod
See FinderFromMethod.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderFromResource - Class in org.apache.commons.digester3.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.digester3.plugins.strategies.FinderFromResource
Constructor.
FinderFromResource(String) - Constructor for class org.apache.commons.digester3.plugins.strategies.FinderFromResource
See FinderFromResource.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderSetProperties - Class in org.apache.commons.digester3.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.digester3.plugins.strategies.FinderSetProperties
See FinderSetProperties.findLoader(org.apache.commons.digester3.Digester, java.lang.Class, java.util.Properties).
FinderSetProperties(String, String) - Constructor for class org.apache.commons.digester3.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.
findLoader(Digester, String, Class<?>, Properties) - Method in class org.apache.commons.digester3.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).
findLoader(Digester, Class<?>, Properties) - Method in class org.apache.commons.digester3.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.digester3.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.digester3.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.digester3.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.digester3.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.digester3.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.digester3.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.digester3.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.digester3.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.
findNamespaceURI(String) - Method in class org.apache.commons.digester3.Digester
Return the currently mapped namespace URI for the specified prefix, if any; otherwise return null.
finish() - Method in class org.apache.commons.digester3.BeanPropertySetterRule
This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
finish() - Method in class org.apache.commons.digester3.CallMethodRule
This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
finish() - Method in class org.apache.commons.digester3.FactoryCreateRule
This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
finish() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginCreateRule
Duplicate the processing that the Digester does when firing the begin methods of rules.
fireEndMethods(List<Rule>, String, String) - Method in class org.apache.commons.digester3.plugins.PluginCreateRule
Duplicate the processing that the Digester does when firing the end methods of rules.
fireOnBegin - Variable in class org.apache.commons.digester3.AbstractMethodRule
Should this rule be invoked when AbstractMethodRule.begin(String, String, Attributes) (true) or AbstractMethodRule.end(String, String) (false) methods are invoked, false by default.
fireOnBegin(boolean) - Method in class org.apache.commons.digester3.binder.AbstractParamTypeBuilder
Marks the rule be invoked when begin or end events match.
forPattern(String) - Method in class org.apache.commons.digester3.binder.AbstractNamespaceURIBasedRulesModule
Allows user binding one or more Digester rules to the input pattern.
forPattern(String) - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Allows user binding one or more Digester rules to the input pattern.
forPattern(String) - Method in interface org.apache.commons.digester3.binder.RulesBinder
Allows to associate the given pattern to one or more Digester rules.
FromAnnotationsRuleModule - Class in org.apache.commons.digester3.annotations
RulesModule implementation that allows loading rules from annotated classes.
FromAnnotationsRuleModule() - Constructor for class org.apache.commons.digester3.annotations.FromAnnotationsRuleModule
 
fromAttribute(String) - Method in class org.apache.commons.digester3.binder.CallParamBuilder
Sets the attribute from which to save the parameter value.
fromStack(boolean) - Method in class org.apache.commons.digester3.binder.CallParamBuilder
Flags the parameter to be set from the stack.
fromStack - Variable in class org.apache.commons.digester3.CallParamRule
Is the parameter to be set from the stack?
FromXmlRulesModule - Class in org.apache.commons.digester3.xmlrules
RulesModule implementation that allows loading rules from XML files.
FromXmlRulesModule() - Constructor for class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
 

G

get() - Method in interface org.apache.commons.digester3.binder.RuleProvider
Provides an instance of Rule.
getAllowUnknownChildElements() - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
Return the flag to ignore any child element for which there is no corresponding object property
getAnnotation(Class<T>) - Method in class org.apache.commons.digester3.annotations.reflect.MethodArgument
getAnnotationNamespaceURI(Annotation) - Static method in class org.apache.commons.digester3.annotations.utils.AnnotationUtils
Extract the namespaceURI() from annotation.
getAnnotationPattern(Annotation) - Static method in class org.apache.commons.digester3.annotations.utils.AnnotationUtils
Extract the pattern() from annotation.
getAnnotations() - Method in class org.apache.commons.digester3.annotations.reflect.MethodArgument
getAnnotationsArrayValue(Annotation) - Static method in class org.apache.commons.digester3.annotations.utils.AnnotationUtils
Extract the Annotations array value() from annotation if present, nul otherwise.
getAnnotationValue(Annotation) - Static method in class org.apache.commons.digester3.annotations.utils.AnnotationUtils
Extract the value() from annotation.
getBodyText() - Method in class org.apache.commons.digester3.BeanPropertySetterRule
Returns the body text used to set the property.
getCause() - Method in exception org.apache.commons.digester3.plugins.PluginException
 
getChild() - Method in class org.apache.commons.digester3.AbstractMethodRule
Returns the argument object of method has to be invoked.
getChild() - Method in class org.apache.commons.digester3.SetNextRule
Returns the argument object of method has to be invoked.
getChild() - Method in class org.apache.commons.digester3.SetRootRule
Returns the argument object of method has to be invoked.
getChild() - Method in class org.apache.commons.digester3.SetTopRule
Returns the argument object of method has to be invoked.
getClassLoader() - Method in class org.apache.commons.digester3.Digester
Return the class loader to be used for instantiating application objects when required.
getContextClassLoader() - Method in interface org.apache.commons.digester3.binder.RulesBinder
Returns the context ClassLoader.
getCount() - Method in class org.apache.commons.digester3.Digester
Return the current depth of the element stack.
getCurrentElementName() - Method in class org.apache.commons.digester3.Digester
Return the name of the XML element that is currently being processed.
getCurrentNamespaces() - Method in class org.apache.commons.digester3.Digester
Get the most current namespaces for all prefixes.
getCustomContentHandler() - Method in class org.apache.commons.digester3.Digester
returns the custom SAX ContentHandler where events are redirected.
getDeclarationByClass(String) - Method in class org.apache.commons.digester3.plugins.PluginManager
Return the declaration object with the specified class.
getDeclarationById(String) - Method in class org.apache.commons.digester3.plugins.PluginManager
Return the declaration object with the specified id.
getDeclaredAnnotations() - Method in class org.apache.commons.digester3.annotations.reflect.MethodArgument
getDefaults() - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Gets Rule's which will be fired when the wrapped implementation returns no matches
getDigester() - Method in class org.apache.commons.digester3.AbstractObjectCreationFactory
Returns the Digester that was set by the FactoryCreateRule upon initialization.
getDigester() - Method in class org.apache.commons.digester3.AbstractRulesImpl
Return the Digester instance with which this Rules instance is associated.
getDigester() - Method in interface org.apache.commons.digester3.ObjectCreationFactory
Returns the Digester that was set by the FactoryCreateRule upon initialization.
getDigester() - Method in class org.apache.commons.digester3.plugins.PluginRules
Return the Digester instance with which this instance is associated.
getDigester() - Method in class org.apache.commons.digester3.Rule
Return the Digester with which this Rule is associated.
getDigester() - Method in interface org.apache.commons.digester3.Rules
Return the Digester instance with which this Rules instance is associated.
getDigester() - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Return the Digester instance with which this Rules instance is associated.
getDocumentLocator() - Method in class org.apache.commons.digester3.Digester
Gets the document locator associated with our parser.
getEntityResolver() - Method in class org.apache.commons.digester3.Digester
Return the Entity Resolver used by the SAX parser.
getErrorHandler() - Method in class org.apache.commons.digester3.Digester
Return the error handler for this Digester.
getExecutorService() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Returns the executor service used to run asynchronous parse method.
getExecutorService() - Method in class org.apache.commons.digester3.Digester
Returns the executor service used to run asynchronous parse method.
getFactory() - Method in class org.apache.commons.digester3.Digester
Return the SAXParserFactory we will use, creating one if necessary.
getFactory(Attributes) - Method in class org.apache.commons.digester3.FactoryCreateRule
Return an instance of our associated object creation factory, creating one if necessary.
getFeature(String) - Method in class org.apache.commons.digester3.Digester
Returns a flag indicating whether the requested feature is supported by the underlying implementation of org.xml.sax.XMLReader.
getFireOnBegin(Annotation) - Static method in class org.apache.commons.digester3.annotations.utils.AnnotationUtils
Extract the fireOnBegin() from annotation.
getId() - Method in class org.apache.commons.digester3.plugins.Declaration
Return the id associated with this declaration.
getIndex() - Method in class org.apache.commons.digester3.annotations.reflect.MethodArgument
Returns the method argument index.
getIndex(String) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getIndex(String, String) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getLength() - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getLocalName(int) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getLog() - Method in class org.apache.commons.digester3.SimpleRegexMatcher
Gets the Log implementation.
getLogger() - Method in class org.apache.commons.digester3.Digester
Return the current Logger associated with this instance of the Digester
getMatch() - Method in class org.apache.commons.digester3.Digester
Return the current rule match path
getMatches() - Method in class org.apache.commons.digester3.Digester
Return a Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().
getNamespaceAware() - Method in class org.apache.commons.digester3.Digester
Return the "namespace aware" flag for parsers we create.
getNamespaceURI() - Method in class org.apache.commons.digester3.AbstractRulesImpl
Return the namespace URI that will be applied to all subsequently added Rule objects.
getNamespaceURI() - Method in class org.apache.commons.digester3.plugins.PluginRules
Return the namespace URI that will be applied to all subsequently added Rule objects.
getNamespaceURI() - Method in class org.apache.commons.digester3.Rule
Return the namespace URI for which this Rule is relevant, if any.
getNamespaceURI() - Method in interface org.apache.commons.digester3.Rules
Return the namespace URI that will be applied to all subsequently added Rule objects.
getNamespaceURI() - Method in interface org.apache.commons.digester3.RuleSet
Return the namespace URI that will be applied to all Rule instances created from this RuleSet.
getNamespaceURI() - Method in class org.apache.commons.digester3.RuleSetBase
Return the namespace URI that will be applied to all Rule instances created from this RuleSet.
getNamespaceURI() - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Return the namespace URI that will be applied to all subsequently added Rule objects.
getParameterType() - Method in class org.apache.commons.digester3.annotations.reflect.MethodArgument
Returns the method argument type.
getParent() - Method in class org.apache.commons.digester3.AbstractMethodRule
Returns the target object of method has to be invoked.
getParent() - Method in class org.apache.commons.digester3.plugins.PluginRules
Return the parent Rules object.
getParent() - Method in class org.apache.commons.digester3.SetNextRule
Returns the target object of method has to be invoked.
getParent() - Method in class org.apache.commons.digester3.SetRootRule
Returns the target object of method has to be invoked.
getParent() - Method in class org.apache.commons.digester3.SetTopRule
Returns the target object of method has to be invoked.
getParser() - Method in class org.apache.commons.digester3.Digester
Return the SAXParser we will use to parse the input stream.
getPattern() - Method in class org.apache.commons.digester3.plugins.PluginCreateRule
Return the pattern that this Rule is associated with.
getPluginClass() - Method in class org.apache.commons.digester3.plugins.Declaration
Return plugin class associated with this declaration.
getPluginClassAttr() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginRules
See PluginContext.getPluginClassAttr().
getPluginClassAttrNs() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginRules
See PluginContext.getPluginClassAttrNs().
getPluginIdAttr() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginRules
See PluginContext.getPluginIdAttr().
getPluginIdAttrNs() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginRules
See PluginContext.getPluginIdAttrNs().
getPluginManager() - Method in class org.apache.commons.digester3.plugins.PluginRules
Return the object which "knows" about all declared plugins.
getProperty(String) - Method in class org.apache.commons.digester3.Digester
Return the current value of the specified property for the underlying XMLReader implementation.
getPropertyName() - Method in class org.apache.commons.digester3.BeanPropertySetterRule
Returns the property name associated to this setter rule.
getPublicId() - Method in class org.apache.commons.digester3.Digester
Return the public identifier of the DTD we are currently parsing under, if any.
getQName(int) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getRegexMatcher() - Method in class org.apache.commons.digester3.RegexRules
Gets the current regex matching strategy.
getRegistrations() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Return the set of DTD URL registrations, keyed by public identifier.
getRoot() - Method in class org.apache.commons.digester3.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.digester3.plugins.PluginContext
Return the list of RuleFinder objects.
getRuleFinders() - Method in class org.apache.commons.digester3.plugins.PluginRules
See PluginContext.getRuleFinders().
getRuleNamespaceURI() - Method in class org.apache.commons.digester3.Digester
Return the namespace URI that will be applied to all subsequently added Rule objects.
getRules() - Method in class org.apache.commons.digester3.Digester
Return the Rules implementation object containing our rules collection and associated matching policy.
getRulesFactory() - Method in class org.apache.commons.digester3.plugins.PluginRules
Return the rules factory object (or null if one has not been specified).
getSAXLogger() - Method in class org.apache.commons.digester3.Digester
Gets the logger used for logging SAX-related information.
getStackAction() - Method in class org.apache.commons.digester3.Digester
Return the callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.
getSubstitutor() - Method in class org.apache.commons.digester3.Digester
Gets the Substitutor used to convert attributes and body text.
getSystemIds() - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Returns the XML source SystemIds load by this module.
getTrimData() - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
Return the flag to have leading and trailing whitespace removed.
getType(int) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getType(String) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getType(String, String) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getURI(int) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getUseContextClassLoader() - Method in class org.apache.commons.digester3.Digester
Return the boolean as to whether the context ClassLoader should be used.
getUseExactMatch() - Method in class org.apache.commons.digester3.CallMethodRule
Should MethodUtils.invokeExactMethod be used for the reflection.
getValidating() - Method in class org.apache.commons.digester3.Digester
Return the validating parser flag.
getValue(int) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getValue(String) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getValue(String, String) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
getXIncludeAware() - Method in class org.apache.commons.digester3.Digester
Return the XInclude-aware flag for parsers we create.
getXMLReader() - Method in class org.apache.commons.digester3.Digester
Return the XMLReader to be used for parsing the input document.
getXMLSchema() - Method in class org.apache.commons.digester3.Digester
Return the XML Schema used when parsing.

H

handle(A, E, RulesBinder) - Method in interface org.apache.commons.digester3.annotations.AnnotationHandler
Handles the current visited element with the related current annotation.
handle(BeanPropertySetter, Field, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.BeanPropertySetterHandler
Handles the current visited element with the related current annotation.
handle(CallMethod, Method, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.CallMethodHandler
Handles the current visited element with the related current annotation.
handle(CallParam, MethodArgument, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.CallParamHandler
Handles the current visited element with the related current annotation.
handle(FactoryCreate, Class<?>, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.FactoryCreateHandler
Handles the current visited element with the related current annotation.
handle(ObjectCreate, Class<?>, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.ObjectCreateHandler
Handles the current visited element with the related current annotation.
handle(PathCallParam, MethodArgument, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.PathCallParamHandler
Handles the current visited element with the related current annotation.
handle(SetProperty, Field, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.SetPropertiesHandler
Handles the current visited element with the related current annotation.
handle(SetTop, Method, RulesBinder) - Method in class org.apache.commons.digester3.annotations.handlers.SetTopHandler
Handles the current visited element with the related current annotation.

I

ignorableWhitespace(char[], int, int) - Method in class org.apache.commons.digester3.Digester
ignoreAttribute(String) - Method in class org.apache.commons.digester3.binder.SetPropertiesBuilder
Add an attribute name to the ignore list.
ignoreCreateExceptions(boolean) - Method in class org.apache.commons.digester3.binder.FactoryCreateBuilder
Exceptions thrown by the object creation factory will be ignored or not.
ignoreElement(String) - Method in class org.apache.commons.digester3.binder.NestedPropertiesBuilder
Allows ignore a matching element.
ignoreMissingProperty(boolean) - Method in class org.apache.commons.digester3.binder.SetPropertiesBuilder
Sets whether attributes found in the XML without matching properties should be ignored.
init(Digester, PluginManager) - Method in class org.apache.commons.digester3.plugins.Declaration
Must be called exactly once, and must be called before any call to the configure method.
init(Attributes, VariableExpander) - Method in class org.apache.commons.digester3.substitution.VariableAttributes
Specify which attributes class this object is a proxy for.
InitializableRule - Interface in org.apache.commons.digester3.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.digester3.Digester
Provides a hook for lazy initialization of this Digester instance.
inputSources - Variable in class org.apache.commons.digester3.Digester
List of InputSource instances created by a createInputSourceFromURL() method call.
install(RulesModule) - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Uses the given module to configure more bindings.
install(RulesModule) - Method in interface org.apache.commons.digester3.binder.RulesBinder
Allows sub-modules inclusion while binding rules.
isAnnotationPresent(Class<? extends Annotation>) - Method in class org.apache.commons.digester3.annotations.reflect.MethodArgument
isConfigured() - Method in class org.apache.commons.digester3.Digester
Checks the Digester instance has been configured.
isEmpty(String) - Method in class org.apache.commons.digester3.Digester
Is the stack with the given name empty?
isExactMatch() - Method in class org.apache.commons.digester3.AbstractMethodRule
Is exact matching being used.
isFireOnBegin() - Method in class org.apache.commons.digester3.AbstractMethodRule
Returns the flag this rule be invoked when AbstractMethodRule.begin(String, String, Attributes) (true) or AbstractMethodRule.end(String, String) (false) methods are invoked, false by default.
isIgnoreMissingProperty() - Method in class org.apache.commons.digester3.SetPropertiesRule
Are attributes found in the xml without matching properties to be ignored?
isNamespaceAware() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Return the "namespace aware" flag for parsers we create.
isValidating() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Return the validating parser flag.
isXIncludeAware() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Return the XInclude-aware flag for parsers we create;

L

LinkedRuleBuilder - Class in org.apache.commons.digester3.binder
Builder invoked to bind one or more rules to a pattern.
LoaderFromClass - Class in org.apache.commons.digester3.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.digester3.plugins.strategies.LoaderFromClass
Constructor.
LoaderFromClass(Class<?>, String) - Constructor for class org.apache.commons.digester3.plugins.strategies.LoaderFromClass
Constructor.
LoaderFromStream - Class in org.apache.commons.digester3.plugins.strategies
A rule-finding algorithm which loads an xmlplugins-format file.
LoaderFromStream(InputStream) - Constructor for class org.apache.commons.digester3.plugins.strategies.LoaderFromStream
The contents of the input stream are loaded into memory, and cached for later use.
LoaderSetProperties - Class in org.apache.commons.digester3.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.digester3.plugins.strategies.LoaderSetProperties
 
loadRules(Digester, Class<?>, InputStream, String) - Static method in class org.apache.commons.digester3.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.
loadRules() - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
 
loadXMLRules(InputSource) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Reads the XML rules from the given org.xml.sax.InputSource.
loadXMLRules(InputStream) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Opens a new org.xml.sax.InputSource given a java.io.InputStream.
loadXMLRules(Reader) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Opens a new org.xml.sax.InputSource given a java.io.Reader.
loadXMLRules(File) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Opens a new org.xml.sax.InputSource given a java.io.File.
loadXMLRules(String) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Opens a new org.xml.sax.InputSource given a URI in String representation.
loadXMLRules(URL) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Opens a new org.xml.sax.InputSource given a java.net.URL.
loadXMLRulesFromText(String) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Opens a new org.xml.sax.InputSource given an XML document in textual form.
locateMethod(Class<?>, String) - Static method in class org.apache.commons.digester3.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);.
lookup(String, String) - Method in class org.apache.commons.digester3.RulesBase
Return a List of Rule instances for the specified pattern that also match the specified namespace URI (if any).

M

match(String, String, String, Attributes) - Method in class org.apache.commons.digester3.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, String, Attributes) - Method in class org.apache.commons.digester3.plugins.PluginRules
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.digester3.RegexMatcher
Returns true if the given pattern matches the given path according to the regex algorithm that this strategy applies.
match(String, String, String, Attributes) - Method in class org.apache.commons.digester3.RegexRules
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, String, Attributes) - Method in interface org.apache.commons.digester3.RuleMatcher
Use the specified parameter to perform a test.
match(String, String, String, Attributes) - Method in interface org.apache.commons.digester3.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, String, Attributes) - Method in class org.apache.commons.digester3.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.digester3.SimpleRegexMatcher
Returns true if the given pattern matches the given path according to the regex algorithm that this strategy applies.
match(String, String, String, Attributes) - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
matchingAttribute(String) - Method in class org.apache.commons.digester3.binder.ObjectParamBuilder
The attribute which we are attempting to match.
MethodArgument - Class in org.apache.commons.digester3.annotations.reflect
Class to supply the missing Java AnnotatedElement for method arguments.
MethodArgument(int, Class<?>, Annotation[]) - Constructor for class org.apache.commons.digester3.annotations.reflect.MethodArgument
Creates a new method argument as AnnotatedElement.
methodName - Variable in class org.apache.commons.digester3.AbstractMethodRule
The method name to call on the parent object.
methodName - Variable in class org.apache.commons.digester3.CallMethodRule
The method name to call on the parent object.
MultiVariableExpander - Class in org.apache.commons.digester3.substitution
Expands variable references from multiple sources.
MultiVariableExpander() - Constructor for class org.apache.commons.digester3.substitution.MultiVariableExpander
 

N

name - Variable in class org.apache.commons.digester3.SetPropertyRule
The attribute that will contain the property name.
NestedPropertiesBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setNestedProperties().
newDigester() - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new Digester instance that relies on the default Rules implementation.
newDigester(Rules) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new Digester instance that relies on the custom user define Rules implementation
newDigester(SAXParser) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new Digester instance that relies on the given SAXParser and the default Rules implementation.
newDigester(SAXParser, Rules) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new Digester instance that relies on the given SAXParser and custom user define Rules implementation.
newDigester(XMLReader) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new XMLReader instance that relies on the given XMLReader and the default Rules implementation.
newDigester(XMLReader, Rules) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new XMLReader instance that relies on the given XMLReader and custom user define Rules implementation.
newInstance(Class<H>) - Method in interface org.apache.commons.digester3.annotations.AnnotationHandlerFactory
Return an instance of the specified type.
newLoader(RulesModule...) - Static method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new DigesterLoader instance given one or more RulesModule instance.
newLoader(Iterable<RulesModule>) - Static method in class org.apache.commons.digester3.binder.DigesterLoader
Creates a new DigesterLoader instance given a collection of RulesModule instance.
newRules(Digester, Class<?>) - Method in class org.apache.commons.digester3.plugins.RulesFactory
Return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing rules.
NodeCreateRule - Class in org.apache.commons.digester3
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.digester3.NodeCreateRule
Default constructor.
NodeCreateRule(DocumentBuilder) - Constructor for class org.apache.commons.digester3.NodeCreateRule
Constructor.
NodeCreateRule(int) - Constructor for class org.apache.commons.digester3.NodeCreateRule
Constructor.
NodeCreateRule(int, DocumentBuilder) - Constructor for class org.apache.commons.digester3.NodeCreateRule
Constructor.
NodeCreateRuleProvider - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.createNode().
NodeCreateRuleProvider.NodeType - Enum in org.apache.commons.digester3.binder
Enumeration that wraps admitted Node node constants.
notationDecl(String, String, String) - Method in class org.apache.commons.digester3.Digester

O

ObjectCreate - Annotation Type in org.apache.commons.digester3.annotations.rules
Classes annotated with ObjectCreate will be bound with ObjectCreateRule digester rule.
ObjectCreate.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @ObjectCreate annotations on the same element.
ObjectCreateBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.createObject().
ObjectCreateHandler - Class in org.apache.commons.digester3.annotations.handlers
ObjectCreateHandler handler.
ObjectCreateHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.ObjectCreateHandler
 
ObjectCreateRule - Class in org.apache.commons.digester3
Rule implementation that creates a new object and pushes it onto the object stack.
ObjectCreateRule(String) - Constructor for class org.apache.commons.digester3.ObjectCreateRule
Construct an object create rule with the specified class name.
ObjectCreateRule(Class<?>) - Constructor for class org.apache.commons.digester3.ObjectCreateRule
Construct an object create rule with the specified class.
ObjectCreateRule(String, String) - Constructor for class org.apache.commons.digester3.ObjectCreateRule
Construct an object create rule with the specified class name and an optional attribute name containing an override.
ObjectCreateRule(String, Class<?>) - Constructor for class org.apache.commons.digester3.ObjectCreateRule
Construct an object create rule with the specified class and an optional attribute name containing an override.
ObjectCreationFactory<T> - Interface in org.apache.commons.digester3
Interface for use with FactoryCreateRule.
objectParam(T) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Saves a parameter for use by a surrounding LinkedRuleBuilder.callMethod(String).
ObjectParamBuilder<T> - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.objectParam(Object).
ObjectParamRule - Class in org.apache.commons.digester3
Rule implementation that saves a parameter for use by a surrounding CallMethodRule.
ObjectParamRule(int, Object) - Constructor for class org.apache.commons.digester3.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.digester3.ObjectParamRule
Construct a "call parameter" rule that will save the given Object as the parameter value, provided that the specified attribute exists.
ofIndex(int) - Method in class org.apache.commons.digester3.binder.CallParamBuilder
Sets the zero-relative parameter number.
ofIndex(int) - Method in class org.apache.commons.digester3.binder.ObjectParamBuilder
The zero-relative index of the parameter we are saving.
ofIndex(int) - Method in class org.apache.commons.digester3.binder.PathCallParamBuilder
Sets the zero-relative parameter number.
ofType(String) - Method in class org.apache.commons.digester3.binder.FactoryCreateBuilder
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.
ofType(Class<? extends ObjectCreationFactory<?>>) - Method in class org.apache.commons.digester3.binder.FactoryCreateBuilder
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.
ofType(NodeCreateRuleProvider.NodeType) - Method in class org.apache.commons.digester3.binder.NodeCreateRuleProvider
NodeCreateRule instance will be created either a DOM Element or a DOM DocumentFragment, depending on the value of the nodeType parameter.
ofType(String) - Method in class org.apache.commons.digester3.binder.ObjectCreateBuilder
Construct an object with the specified class name.
ofType(Class<T>) - Method in class org.apache.commons.digester3.binder.ObjectCreateBuilder
Construct an object with the specified class.
ofType(Class<T>) - Method in class org.apache.commons.digester3.binder.PluginCreateRuleBuilder
Set the class which any specified plugin must be descended from.
ofTypeSpecifiedByAttribute(String) - Method in class org.apache.commons.digester3.binder.ObjectCreateBuilder
Allows specify the attribute containing an override class name if it is present.
onPop(Digester, String, T) - Method in interface org.apache.commons.digester3.StackAction
Invoked just after an object has been popped from a digester stack.
onPush(Digester, String, T) - Method in interface org.apache.commons.digester3.StackAction
Invoked just before an object is to be pushed onto a digester stack.
org.apache.commons.digester3 - package org.apache.commons.digester3
The xmlrules package provides for XML-based definition of rules for Digester.
org.apache.commons.digester3.annotations - package org.apache.commons.digester3.annotations
The annotations package provides for Java5 Annotations meta data-based definition of rules for Digester.
org.apache.commons.digester3.annotations.handlers - package org.apache.commons.digester3.annotations.handlers
The handlers package contains AnnotationHandler implementations.
org.apache.commons.digester3.annotations.reflect - package org.apache.commons.digester3.annotations.reflect
The reflect package supply missing JVM classes to alow user manipulate entities as AnnotatedElement.
org.apache.commons.digester3.annotations.rules - package org.apache.commons.digester3.annotations.rules
Classes contained in this package are annotations that reflect Digester rules.
org.apache.commons.digester3.annotations.utils - package org.apache.commons.digester3.annotations.utils
Contains commons utilities classes for Java5 Annotations manipulation.
org.apache.commons.digester3.binder - package org.apache.commons.digester3.binder
The Digester EDSL allows configure Digester using fluent APIs.
org.apache.commons.digester3.plugins - package org.apache.commons.digester3.plugins
The plugins package provides an easy mechanism whereby new digestion rules can be added dynamically during a digestion.
org.apache.commons.digester3.plugins.strategies - package org.apache.commons.digester3.plugins.strategies
The plugins.strategies package contains "rule-finding" strategy classes, and their associated "helper" loader classes.
org.apache.commons.digester3.substitution - package org.apache.commons.digester3.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.digester3.xmlrules - package org.apache.commons.digester3.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.
overriddenByAttribute(String) - Method in class org.apache.commons.digester3.binder.FactoryCreateBuilder
Allows specify the attribute containing an override class name if it is present.

P

param - Variable in class org.apache.commons.digester3.ObjectParamRule
The parameter we wish to pass to the method call
paramCount - Variable in class org.apache.commons.digester3.CallMethodRule
The number of parameters to collect from MethodParam rules.
paramIndex - Variable in class org.apache.commons.digester3.CallParamRule
The zero-relative index of the parameter we are saving.
paramIndex - Variable in class org.apache.commons.digester3.ObjectParamRule
The zero-relative index of the parameter we are saving.
paramIndex - Variable in class org.apache.commons.digester3.PathCallParamRule
The zero-relative index of the parameter we are saving.
paramType - Variable in class org.apache.commons.digester3.AbstractMethodRule
The Java class name of the parameter type expected by the method.
paramTypeName - Variable in class org.apache.commons.digester3.AbstractMethodRule
The Java class name of the parameter type expected by the method.
paramTypes - Variable in class org.apache.commons.digester3.CallMethodRule
The parameter types of the parameters to be collected.
parse(File) - Method in class org.apache.commons.digester3.Digester
Parse the content of the specified file using this Digester.
parse(InputSource) - Method in class org.apache.commons.digester3.Digester
Parse the content of the specified input source using this Digester.
parse(InputStream) - Method in class org.apache.commons.digester3.Digester
Parse the content of the specified input stream using this Digester.
parse(Reader) - Method in class org.apache.commons.digester3.Digester
Parse the content of the specified reader using this Digester.
parse(String) - Method in class org.apache.commons.digester3.Digester
Parse the content of the specified URI using this Digester.
parse(URL) - Method in class org.apache.commons.digester3.Digester
Parse the content of the specified URL using this Digester.
PathCallParam - Annotation Type in org.apache.commons.digester3.annotations.rules
Methods arguments annotated with PathCallParam will be bound with PathCallParamRule digester rule.
PathCallParam.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @PathCallParam annotations on the same element.
PathCallParamBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.callParamPath().
PathCallParamHandler - Class in org.apache.commons.digester3.annotations.handlers
PathCallParam handler.
PathCallParamHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.PathCallParamHandler
 
PathCallParamRule - Class in org.apache.commons.digester3
Rule implementation that saves a parameter containing the Digester matching path for use by a surrounding CallMethodRule.
PathCallParamRule(int) - Constructor for class org.apache.commons.digester3.PathCallParamRule
Construct a "call parameter" rule that will save the body text of this element as the parameter value.
peek() - Method in class org.apache.commons.digester3.Digester
Return the top object on the stack without removing it.
peek(int) - Method in class org.apache.commons.digester3.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.digester3.Digester
Gets the top object from the stack with the given name.
peek(String, int) - Method in class org.apache.commons.digester3.Digester
Gets the top object from the stack with the given name.
peekParams() - Method in class org.apache.commons.digester3.Digester
Return the top object on the parameters stack without removing it.
peekParams(int) - Method in class org.apache.commons.digester3.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.digester3.plugins
Thrown when a bug is detected in the plugins code.
PluginAssertionFailure(Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginAssertionFailure
Constructs a new exception with the specified cause.
PluginAssertionFailure(String) - Constructor for exception org.apache.commons.digester3.plugins.PluginAssertionFailure
Constructs a new exception with the specified detail message.
PluginAssertionFailure(String, Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginAssertionFailure
Constructs a new exception with the specified detail message and cause.
PluginConfigurationException - Exception in org.apache.commons.digester3.plugins
Thrown when an error occurs due to the way the calling application uses the plugins module.
PluginConfigurationException(Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginConfigurationException
Constructs a new exception with the specified cause.
PluginConfigurationException(String) - Constructor for exception org.apache.commons.digester3.plugins.PluginConfigurationException
Constructs a new exception with the specified detail message.
PluginConfigurationException(String, Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginConfigurationException
Constructs a new exception with the specified detail message and cause.
PluginContext - Class in org.apache.commons.digester3.plugins
Provides data and services which should exist only once per digester.
PluginContext() - Constructor for class org.apache.commons.digester3.plugins.PluginContext
 
PluginCreateRule - Class in org.apache.commons.digester3.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.digester3.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.digester3.plugins.PluginCreateRule
Create a plugin rule where the user may specify a plugin.
PluginCreateRule(Class<?>, Class<?>, RuleLoader) - Constructor for class org.apache.commons.digester3.plugins.PluginCreateRule
Create a plugin rule where the user may specify a plugin.
PluginCreateRuleBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.createPlugin().
PluginDeclarationRule - Class in org.apache.commons.digester3.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.digester3.plugins.PluginDeclarationRule
constructor
PluginDeclarationRuleBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.declarePlugin().
PluginException - Exception in org.apache.commons.digester3.plugins
Thrown when some plugin-related error has occurred, and none of the other exception types are appropriate.
PluginException(Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginException
 
PluginException(String) - Constructor for exception org.apache.commons.digester3.plugins.PluginException
 
PluginException(String, Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginException
 
PluginInvalidInputException - Exception in org.apache.commons.digester3.plugins
Thrown when an error occurs due to bad data in the file being parsed.
PluginInvalidInputException(Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginInvalidInputException
Constructs a new exception with the specified cause.
PluginInvalidInputException(String) - Constructor for exception org.apache.commons.digester3.plugins.PluginInvalidInputException
Constructs a new exception with the specified detail message.
PluginInvalidInputException(String, Throwable) - Constructor for exception org.apache.commons.digester3.plugins.PluginInvalidInputException
Constructs a new exception with the specified detail message and cause.
PluginManager - Class in org.apache.commons.digester3.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.digester3.plugins.PluginManager
Construct a "root" PluginManager, ie one with no parent.
PluginManager(PluginManager) - Constructor for class org.apache.commons.digester3.plugins.PluginManager
Construct a "child" PluginManager.
PluginRules - Class in org.apache.commons.digester3.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.digester3.plugins.PluginRules
Constructor for top-level Rules objects.
PluginRules(Rules) - Constructor for class org.apache.commons.digester3.plugins.PluginRules
Constructor for top-level Rules object which handles rule-matching using the specified implementation.
pop() - Method in class org.apache.commons.digester3.Digester
Pop the top object off of the stack, and return it.
pop(String) - Method in class org.apache.commons.digester3.Digester
Pops (gets and removes) the top object from the stack with the given name.
popParams() - Method in class org.apache.commons.digester3.Digester
Pop the top object off of the parameters stack, and return it.
postRegisterInit(String) - Method in interface org.apache.commons.digester3.plugins.InitializableRule
Called after this Rule object has been added to the list of all Rules.
postRegisterInit(String) - Method in class org.apache.commons.digester3.plugins.PluginCreateRule
Called after this Rule object has been added to the list of all Rules.
processingInstruction(String, String) - Method in class org.apache.commons.digester3.Digester
processMethodCallResult(Object) - Method in class org.apache.commons.digester3.CallMethodRule
Subclasses may override this method to perform additional processing of the invoked method's result.
push(T) - Method in class org.apache.commons.digester3.Digester
Push a new object onto the top of the object stack.
push(String, T) - Method in class org.apache.commons.digester3.Digester
Pushes the given object onto the stack with the given name.
pushParams(Object...) - Method in class org.apache.commons.digester3.Digester
Push a new object onto the top of the parameters stack.

R

RegexMatcher - Class in org.apache.commons.digester3
Regular expression matching strategy for RegexRules.
RegexMatcher() - Constructor for class org.apache.commons.digester3.RegexMatcher
 
RegexRules - Class in org.apache.commons.digester3
Rules implementation that uses regular expression matching for paths.
RegexRules(RegexMatcher) - Constructor for class org.apache.commons.digester3.RegexRules
Construct sets the Regex matching strategy.
register(String, URL) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Register the specified DTD URL for the specified public identifier.
register(String, String) - Method in class org.apache.commons.digester3.binder.DigesterLoader
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.digester3.Digester
Register the specified DTD URL for the specified public identifier.
register(String, String) - Method in class org.apache.commons.digester3.Digester
Convenience method that registers the string version of an entity URL instead of a URL version.
registerAll(Map<String, URL>) - Method in class org.apache.commons.digester3.Digester
Convenience method that registers DTD URLs for the specified public identifiers.
registerRule(String, Rule) - Method in class org.apache.commons.digester3.AbstractRulesImpl
Register rule at given pattern.
registerRule(String, Rule) - Method in class org.apache.commons.digester3.ExtendedBaseRules
Register rule at given pattern.
registerRule(String, Rule) - Method in class org.apache.commons.digester3.RegexRules
Register rule at given pattern.
registerRule(String, Rule) - Method in class org.apache.commons.digester3.RulesBase
Register rule at given pattern.
resetRoot() - Method in class org.apache.commons.digester3.Digester
This method allows the "root" variable to be reset to null.
resolveEntity(String, String) - Method in class org.apache.commons.digester3.Digester
Rule - Class in org.apache.commons.digester3
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.digester3.Rule
 
RuleFinder - Class in org.apache.commons.digester3.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.digester3.plugins.RuleFinder
 
RuleLoader - Class in org.apache.commons.digester3.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.digester3.plugins.RuleLoader
 
RuleMatcher - Interface in org.apache.commons.digester3
Defines a functor interface implemented by classes that perform a predicate test
RuleProvider<R extends Rule> - Interface in org.apache.commons.digester3.binder
An object capable of providing instances of Rule.
rules() - Method in class org.apache.commons.digester3.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.digester3.RegexRules
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
Rules - Interface in org.apache.commons.digester3
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.
rules() - Method in interface org.apache.commons.digester3.Rules
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
rules - Variable in class org.apache.commons.digester3.RulesBase
The set of registered Rule instances, in the order that they were originally registered.
rules() - Method in class org.apache.commons.digester3.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.digester3.WithDefaultsRulesWrapper
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
RulesBase - Class in org.apache.commons.digester3
Default implementation of the Rules interface that supports the standard rule matching behavior.
RulesBase() - Constructor for class org.apache.commons.digester3.RulesBase
 
rulesBinder() - Method in class org.apache.commons.digester3.binder.AbstractRulesModule
Return the wrapped RulesBinder.
RulesBinder - Interface in org.apache.commons.digester3.binder
The Digester EDSL.
RuleSet - Interface in org.apache.commons.digester3
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.digester3
Convenience base class that implements the RuleSet interface.
RuleSetBase() - Constructor for class org.apache.commons.digester3.RuleSetBase
Build a new RuleSetBase with a null namespaceURI
RuleSetBase(String) - Constructor for class org.apache.commons.digester3.RuleSetBase
Build a new RuleSetBase with the given namespaceURI
RulesFactory - Class in org.apache.commons.digester3.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.digester3.plugins.RulesFactory
 
RulesModule - Interface in org.apache.commons.digester3.binder
A module is the Digester rule bindings provider.

S

setAllowUnknownChildElements(boolean) - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
Determines whether an error is reported when a nested element is encountered for which there is no corresponding property-setter method.
setAttributeName(String) - Method in class org.apache.commons.digester3.CallParamRule
Set the attribute from which to save the parameter value.
setBeanProperty() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Construct rule that automatically sets a property from the body text, taking the property name the same as the current element.
setClassLoader(ClassLoader) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Set the class loader to be used for instantiating application objects when required.
setClassLoader(ClassLoader) - Method in class org.apache.commons.digester3.Digester
Set the class loader to be used for instantiating application objects when required.
setCustomContentHandler(ContentHandler) - Method in class org.apache.commons.digester3.Digester
Redirects (or cancels redirecting) of SAX ContentHandler events to an external object.
setDigester(Digester) - Method in class org.apache.commons.digester3.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.digester3.AbstractRulesImpl
Set the Digester instance with which this Rules instance is associated.
setDigester(Digester) - Method in class org.apache.commons.digester3.CallMethodRule
Set the Digester with which this Rule is associated.
setDigester(Digester) - Method in interface org.apache.commons.digester3.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.digester3.plugins.PluginRules
Set the Digester instance with which this Rules instance is associated.
setDigester(Digester) - Method in class org.apache.commons.digester3.Rule
Set the Digester with which this Rule is associated.
setDigester(Digester) - Method in interface org.apache.commons.digester3.Rules
Set the Digester instance with which this Rules instance is associated.
setDigester(Digester) - Method in class org.apache.commons.digester3.RulesBase
Set the Digester instance with which this Rules instance is associated.
setDigester(Digester) - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
Set the Digester with which this Rule is associated.
setDigester(Digester) - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Set the Digester instance with which this Rules instance is associated.
setDocumentLocator(Locator) - Method in class org.apache.commons.digester3.Digester
setEntityResolver(EntityResolver) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Set the EntityResolver used by SAX when resolving public id and system id.
setEntityResolver(EntityResolver) - Method in class org.apache.commons.digester3.Digester
Set the EntityResolver used by SAX when resolving public id and system id.
setErrorHandler(ErrorHandler) - Method in class org.apache.commons.digester3.Digester
Set the error handler for this Digester.
setExactMatch(boolean) - Method in class org.apache.commons.digester3.AbstractMethodRule
Set whether exact matching is enabled.
setExecutorService(ExecutorService) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Sets the executor service to run asynchronous parse method.
setExecutorService(ExecutorService) - Method in class org.apache.commons.digester3.Digester
Sets the executor service to run asynchronous parse method.
setFeature(String, boolean) - Method in class org.apache.commons.digester3.Digester
Sets a flag indicating whether the requested feature is supported by the underlying implementation of org.xml.sax.XMLReader.
setFireOnBegin(boolean) - Method in class org.apache.commons.digester3.AbstractMethodRule
Sets this rule be invoked when AbstractMethodRule.begin(String, String, Attributes) (true) or AbstractMethodRule.end(String, String) (false) methods are invoked, false by default.
setId(String) - Method in class org.apache.commons.digester3.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.digester3.SetPropertiesRule
Sets whether attributes found in the xml without matching properties should be ignored.
setLog(Log) - Method in class org.apache.commons.digester3.SimpleRegexMatcher
Sets the current Log implementation used by this class.
setLogger(Log) - Method in class org.apache.commons.digester3.Digester
Set the current logger for this Digester.
setNamespaceAware(boolean) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Set the "namespace aware" flag for parsers we create.
setNamespaceAware(boolean) - Method in class org.apache.commons.digester3.Digester
Set the "namespace aware" flag for parsers we create.
setNamespaceURI(String) - Method in class org.apache.commons.digester3.AbstractRulesImpl
Set the namespace URI that will be applied to all subsequently added Rule objects.
setNamespaceURI(String) - Method in class org.apache.commons.digester3.plugins.PluginRules
Set the namespace URI that will be applied to all subsequently added Rule objects.
setNamespaceURI(String) - Method in class org.apache.commons.digester3.Rule
Set the namespace URI for which this Rule is relevant, if any.
setNamespaceURI(String) - Method in interface org.apache.commons.digester3.Rules
Set the namespace URI that will be applied to all subsequently added Rule objects.
setNamespaceURI(String) - Method in class org.apache.commons.digester3.WithDefaultsRulesWrapper
Set the namespace URI that will be applied to all subsequently added Rule objects.
setNestedProperties() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Sets properties on the object at the top of the stack, based on child elements with names matching properties on that object.
SetNestedPropertiesRule - Class in org.apache.commons.digester3
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.digester3.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.digester3.SetNestedPropertiesRule
Convenience constructor which overrides the default mappings for just one property.
SetNestedPropertiesRule(String[], String[]) - Constructor for class org.apache.commons.digester3.SetNestedPropertiesRule
Constructor which allows element->property mapping to be overridden.
SetNestedPropertiesRule(Map<String, String>) - Constructor for class org.apache.commons.digester3.SetNestedPropertiesRule
Constructor which allows element->property mapping to be overridden.
SetNext - Annotation Type in org.apache.commons.digester3.annotations.rules
Methods annotated with SetNext will be bound with SetNextRule digester rule.
setNext(String) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Calls a method on the (top-1) (parent) object, passing the top object (child) as an argument, commonly used to establish parent-child relationships.
SetNextBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setNext(String).
SetNextHandler - Class in org.apache.commons.digester3.annotations.handlers
SetNext handler.
SetNextHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.SetNextHandler
 
SetNextRule - Class in org.apache.commons.digester3
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.digester3.SetNextRule
Construct a "set next" rule with the specified method name.
SetNextRule(String, String) - Constructor for class org.apache.commons.digester3.SetNextRule
Construct a "set next" rule with the specified method name.
SetNextRule(String, Class<?>) - Constructor for class org.apache.commons.digester3.SetNextRule
Construct a "set next" rule with the specified method name.
setPluginClassAttribute(String) - Method in class org.apache.commons.digester3.binder.PluginCreateRuleBuilder
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.digester3.binder.PluginCreateRuleBuilder
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.digester3.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.digester3.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.digester3.plugins.PluginRules
See PluginContext.setPluginClassAttribute(java.lang.String, java.lang.String).
setPluginIdAttribute(String) - Method in class org.apache.commons.digester3.binder.PluginCreateRuleBuilder
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.digester3.binder.PluginCreateRuleBuilder
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.digester3.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.digester3.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.digester3.plugins.PluginRules
See PluginContext.setPluginIdAttribute(java.lang.String, java.lang.String).
setProperties() - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Sets properties on the object at the top of the stack, based on attributes with corresponding names.
setProperties(Properties) - Method in class org.apache.commons.digester3.plugins.Declaration
Copy all (key,value) pairs in the param into the properties member of this object.
SetPropertiesBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setProperties().
SetPropertiesHandler - Class in org.apache.commons.digester3.annotations.handlers
SetProperty handler.
SetPropertiesHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.SetPropertiesHandler
 
SetPropertiesRule - Class in org.apache.commons.digester3
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.digester3.SetPropertiesRule
Base constructor.
SetPropertiesRule(String, String) - Constructor for class org.apache.commons.digester3.SetPropertiesRule
Convenience constructor overrides the mapping for just one property.
SetPropertiesRule(String[], String[]) - Constructor for class org.apache.commons.digester3.SetPropertiesRule
Constructor allows attribute->property mapping to be overriden.
SetPropertiesRule(Map<String, String>) - Constructor for class org.apache.commons.digester3.SetPropertiesRule
Constructor allows attribute->property mapping to be overriden.
SetProperty - Annotation Type in org.apache.commons.digester3.annotations.rules
Fields annotated with SetProperty will be bound with SetPropertiesRule digester rule.
setProperty(String) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Sets an individual property on the object at the top of the stack, based on attributes with specified names.
setProperty(String, Object) - Method in class org.apache.commons.digester3.Digester
Set the current value of the specified property for the underlying XMLReader implementation.
SetProperty.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @SetProperty annotations on the same element.
SetPropertyBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setProperty(String).
setPropertyNameFromAttribute(String) - Method in class org.apache.commons.digester3.BeanPropertySetterRule
Sets the attribute name from which the property name has to be extracted.
SetPropertyRule - Class in org.apache.commons.digester3
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.digester3.SetPropertyRule
Construct a "set property" rule with the specified name and value attributes.
setPublicId(String) - Method in class org.apache.commons.digester3.Digester
Set the public id of the current file being parse.
setRegexMatcher(RegexMatcher) - Method in class org.apache.commons.digester3.RegexRules
Sets the current regex matching strategy.
SetRoot - Annotation Type in org.apache.commons.digester3.annotations.rules
Methods annotated with SetRoot will be bound with SetRootRule digester rule.
setRoot(String) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Calls a method on the root object on the stack, passing the top object (child) as an argument.
SetRootBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setRoot(String).
SetRootHandler - Class in org.apache.commons.digester3.annotations.handlers
SetRoot handler.
SetRootHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.SetRootHandler
 
SetRootRule - Class in org.apache.commons.digester3
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.digester3.SetRootRule
Construct a "set root" rule with the specified method name.
SetRootRule(String, String) - Constructor for class org.apache.commons.digester3.SetRootRule
Construct a "set root" rule with the specified method name.
SetRootRule(String, Class<?>) - Constructor for class org.apache.commons.digester3.SetRootRule
Construct a "set root" rule with the specified method name.
setRuleFinders(List<RuleFinder>) - Method in class org.apache.commons.digester3.plugins.PluginContext
Set the list of RuleFinder objects.
setRuleFinders(List<RuleFinder>) - Method in class org.apache.commons.digester3.plugins.PluginRules
See PluginContext.setRuleFinders(java.util.List).
setRuleNamespaceURI(String) - Method in class org.apache.commons.digester3.Digester
Set the namespace URI that will be applied to all subsequently added Rule objects.
setRules(Rules) - Method in class org.apache.commons.digester3.Digester
Set the Rules implementation object containing our rules collection and associated matching policy.
setRulesFactory(RulesFactory) - Method in class org.apache.commons.digester3.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.digester3.Digester
Sets the logger used for logging SAX-related information.
setSchema(Schema) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Set the XML Schema to be used when parsing.
setStackAction(StackAction) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Sets the Object which will receive callbacks for every pop/push action on the default stack or named stacks.
setStackAction(StackAction) - Method in class org.apache.commons.digester3.Digester
Define a callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.
setSubstitutor(Substitutor) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Sets the Substitutor to be used to convert attributes and body text.
setSubstitutor(Substitutor) - Method in class org.apache.commons.digester3.Digester
Sets the Substitutor to be used to convert attributes and body text.
SetTop - Annotation Type in org.apache.commons.digester3.annotations.rules
Methods annotated with SetTop will be bound with SetTopRule digester rule.
setTop(String) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Calls a "set top" method on the top (child) object, passing the (top-1) (parent) object as an argument.
SetTop.List - Annotation Type in org.apache.commons.digester3.annotations.rules
Defines several @SetTop annotations on the same element
SetTopBuilder - Class in org.apache.commons.digester3.binder
Builder chained when invoking LinkedRuleBuilder.setTop(String).
SetTopHandler - Class in org.apache.commons.digester3.annotations.handlers
SetTop handler.
SetTopHandler() - Constructor for class org.apache.commons.digester3.annotations.handlers.SetTopHandler
 
SetTopRule - Class in org.apache.commons.digester3
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.digester3.SetTopRule
Construct a "set top" rule with the specified method name.
SetTopRule(String, String) - Constructor for class org.apache.commons.digester3.SetTopRule
Construct a "set top" rule with the specified method name.
SetTopRule(String, Class<?>) - Constructor for class org.apache.commons.digester3.SetTopRule
Construct a "set top" rule with the specified method name.
setTrimData(boolean) - Method in class org.apache.commons.digester3.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.digester3.binder.DigesterLoader
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.
setUseContextClassLoader(boolean) - Method in class org.apache.commons.digester3.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.digester3.CallMethodRule
Set whether MethodUtils.invokeExactMethod should be used for the reflection.
setValidating(boolean) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Set the validating parser flag.
setValidating(boolean) - Method in class org.apache.commons.digester3.Digester
Set the validating parser flag.
setXIncludeAware(boolean) - Method in class org.apache.commons.digester3.binder.DigesterLoader
Set the XInclude-aware flag for parsers we create.
setXIncludeAware(boolean) - Method in class org.apache.commons.digester3.Digester
Set the XInclude-aware flag for parsers we create.
setXMLSchema(Schema) - Method in class org.apache.commons.digester3.Digester
Set the XML Schema to be used when parsing.
SimpleRegexMatcher - Class in org.apache.commons.digester3
Simple regex pattern matching algorithm.
SimpleRegexMatcher() - Constructor for class org.apache.commons.digester3.SimpleRegexMatcher
 
skippedEntity(String) - Method in class org.apache.commons.digester3.Digester
StackAction - Interface in org.apache.commons.digester3
An interface that can be implemented in order to get notifications of objects being pushed onto a digester stack or popped from one.
stackIndex - Variable in class org.apache.commons.digester3.CallParamRule
The position of the object from the top of the stack
startDocument() - Method in class org.apache.commons.digester3.Digester
startElement(String, String, String, Attributes) - Method in class org.apache.commons.digester3.Digester
startPrefixMapping(String, String) - Method in class org.apache.commons.digester3.Digester
substitute(Attributes) - Method in class org.apache.commons.digester3.substitution.CompoundSubstitutor
Substitutes the attributes (before they are passed to the Rule implementations's).
substitute(String) - Method in class org.apache.commons.digester3.substitution.CompoundSubstitutor
Substitutes for the body text.
substitute(Attributes) - Method in class org.apache.commons.digester3.substitution.VariableSubstitutor
Substitutes the attributes (before they are passed to the Rule implementations's).
substitute(String) - Method in class org.apache.commons.digester3.substitution.VariableSubstitutor
Substitutes for the body text.
substitute(Attributes) - Method in class org.apache.commons.digester3.Substitutor
Substitutes the attributes (before they are passed to the Rule implementations's).
substitute(String) - Method in class org.apache.commons.digester3.Substitutor
Substitutes for the body text.
Substitutor - Class in org.apache.commons.digester3
(Logical) Interface for substitution strategies.
Substitutor() - Constructor for class org.apache.commons.digester3.Substitutor
 

T

targetOffset - Variable in class org.apache.commons.digester3.CallMethodRule
location of the target object for the call, relative to the top of the digester object stack.
toString() - Method in class org.apache.commons.digester3.AbstractMethodRule
toString() - Method in class org.apache.commons.digester3.BeanPropertySetterRule
toString() - Method in class org.apache.commons.digester3.CallMethodRule
toString() - Method in class org.apache.commons.digester3.CallParamRule
toString() - Method in class org.apache.commons.digester3.FactoryCreateRule
toString() - Method in class org.apache.commons.digester3.ObjectCreateRule
toString() - Method in class org.apache.commons.digester3.ObjectParamRule
toString() - Method in class org.apache.commons.digester3.PathCallParamRule
toString() - Method in class org.apache.commons.digester3.SetNestedPropertiesRule
toString() - Method in class org.apache.commons.digester3.SetPropertiesRule
toString() - Method in class org.apache.commons.digester3.SetPropertyRule
trimData(boolean) - Method in class org.apache.commons.digester3.binder.NestedPropertiesBuilder
When set to true, any text within child elements will have leading and trailing whitespace removed before assignment to the target object.

U

unparsedEntityDecl(String, String, String, String) - Method in class org.apache.commons.digester3.Digester
useAnnotationHandlerFactory(AnnotationHandlerFactory) - Method in class org.apache.commons.digester3.annotations.FromAnnotationsRuleModule
Allows users plug a different AnnotationHandlerFactory to create AnnotationHandler instances.
useDefaultAnnotationHandlerFactory() - Method in class org.apache.commons.digester3.annotations.FromAnnotationsRuleModule
Allows users to switch back to the default AnnotationHandlerFactory implementation.
useExactMatch - Variable in class org.apache.commons.digester3.AbstractMethodRule
Should we use exact matching.
useExactMatch(boolean) - Method in class org.apache.commons.digester3.binder.AbstractParamTypeBuilder
Sets exact matching being used.
useExactMatch(boolean) - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
Should MethodUtils.invokeExactMethod be used for the reflection.
useRootPath(String) - Method in class org.apache.commons.digester3.xmlrules.FromXmlRulesModule
Set the root path (will be used when composing modules).
usingDefaultPluginClass(Class<T>) - Method in class org.apache.commons.digester3.binder.PluginCreateRuleBuilder
Set the class which will be used if the user doesn't specify any plugin-class or plugin-id.
usingDocumentBuilder(DocumentBuilder) - Method in class org.apache.commons.digester3.binder.NodeCreateRuleProvider
NodeCreateRule instance will be created a DOM Element, but lets users specify the JAXP DocumentBuilder that should be used when constructing the node tree.
usingElementBodyAsArgument() - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
Prepare the CallMethodRule to be invoked using the matching element body as argument.
usingFactory(ObjectCreationFactory<T>) - Method in class org.apache.commons.digester3.binder.FactoryCreateBuilder
Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.
usingRuleLoader(RL) - Method in class org.apache.commons.digester3.binder.PluginCreateRuleBuilder
Set RuleLoader instance which knows how to load the custom rules associated with the default plugin.

V

value - Variable in class org.apache.commons.digester3.SetPropertyRule
The attribute that will contain the property value.
valueOf(String) - Static method in enum org.apache.commons.digester3.binder.NodeCreateRuleProvider.NodeType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.commons.digester3.binder.NodeCreateRuleProvider.NodeType
Returns an array containing the constants of this enum type, in the order they are declared.
VariableAttributes - Class in org.apache.commons.digester3.substitution
Wrapper for an Attributes object which expands any "variables" referenced in the attribute value via ${foo} or similar.
VariableAttributes() - Constructor for class org.apache.commons.digester3.substitution.VariableAttributes
 
VariableExpander - Interface in org.apache.commons.digester3.substitution
An Interface describing a class capable of expanding strings which may contain variable references.
VariableSubstitutor - Class in org.apache.commons.digester3.substitution
Substitutor implementation that support variable replacement for both attributes and body text.
VariableSubstitutor(VariableExpander) - Constructor for class org.apache.commons.digester3.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.digester3.substitution.VariableSubstitutor
Constructs a Substitutor.

W

W3C_XML_SCHEMA - Static variable in class org.apache.commons.digester3.Digester
The schema language supported.
warning(SAXParseException) - Method in class org.apache.commons.digester3.Digester
WithDefaultsRulesWrapper - Class in org.apache.commons.digester3
Rules Decorator that returns default rules when no matches are returned by the wrapped implementation.
WithDefaultsRulesWrapper(Rules) - Constructor for class org.apache.commons.digester3.WithDefaultsRulesWrapper
Base constructor.
withName(String) - Method in class org.apache.commons.digester3.binder.BeanPropertySetterBuilder
Sets the name of property to set.
withNamespaceURI(String) - Method in class org.apache.commons.digester3.binder.LinkedRuleBuilder
Sets the namespace URI for the current rule pattern.
withParamCount(int) - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
The number of parameters to collect, or zero for a single argument from the body of this element.
withParameterType(Class<?>) - Method in class org.apache.commons.digester3.binder.AbstractParamTypeBuilder
Sets the Java class of the method's argument.
withParameterType(String) - Method in class org.apache.commons.digester3.binder.AbstractParamTypeBuilder
Sets the Java class name of the method's argument.
withParamTypes(String...) - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
Sets the Java class names that represent the parameter types of the method arguments.
withParamTypes(Class<?>...) - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
Sets the Java classes that represent the parameter types of the method arguments.
withStackIndex(int) - Method in class org.apache.commons.digester3.binder.CallParamBuilder
Sets the position of the object from the top of the stack.
withTargetOffset(int) - Method in class org.apache.commons.digester3.binder.CallMethodBuilder
Sets the location of the target object.

A B C D E F G H I L M N O P R S T U V W

Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.