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.

description - Variable in class org.apache.commons.digester3.rss.Channel

The channel description (1-500 characters).

description - Variable in class org.apache.commons.digester3.rss.Image

The image description (1-100 characters).

description - Variable in class org.apache.commons.digester3.rss.Item

The item description (1-500 characters).

description - Variable in class org.apache.commons.digester3.rss.TextInput

The text input description (1-100 characters).

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

docs - Variable in class org.apache.commons.digester3.rss.Channel

The channel description file URL (1-500 characters).

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.examples.api.dbinsert.RowInserterRule

This method is invoked when the end tag for an xml element representing a database row 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

endElement(String, String, String) - Method in class org.apache.commons.digester3.examples.api.documentmarkup.MarkupDigester

Process notification of the end of an XML element being reached.

endPrefixMapping(String) - Method in class org.apache.commons.digester3.Digester

Entry - Class in org.apache.commons.digester3.annotations.atom

 

Entry() - Constructor for class org.apache.commons.digester3.annotations.atom.Entry

 

Entry - Class in org.apache.commons.digester3.edsl.atom

 

Entry() - Constructor for class org.apache.commons.digester3.edsl.atom.Entry

 

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

Feed - Class in org.apache.commons.digester3.annotations.atom

 

Feed() - Constructor for class org.apache.commons.digester3.annotations.atom.Feed

 

Feed - Class in org.apache.commons.digester3.edsl.atom

 

Feed() - Constructor for class org.apache.commons.digester3.edsl.atom.Feed

 

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.

findItems() - Method in class org.apache.commons.digester3.rss.Channel

Return the items for this channel.

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.

findSkipDays() - Method in class org.apache.commons.digester3.rss.Channel

Return the skip days for this channel.

findSkipHours() - Method in class org.apache.commons.digester3.rss.Channel

Return the skip hours for this channel.

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.

forProperty(String) - Method in class org.apache.commons.digester3.binder.AddAliasBuilder

Allows expressing the input property name alias.

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.

getAuthors() - Method in class org.apache.commons.digester3.annotations.atom.Feed

 

getAuthors() - Method in class org.apache.commons.digester3.edsl.atom.Feed

 

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

 

getChannelClass() - Method in class org.apache.commons.digester3.rss.RSSDigester

 

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.

getCity() - Method in class org.apache.commons.digester3.examples.api.addressbook.Address

Returns the value of city.

getCity() - Method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Address

Returns the value of city.

getClassLoader() - Method in class org.apache.commons.digester3.Digester

Return the class loader to be used for instantiating application objects when required.

getColumns() - Method in class org.apache.commons.digester3.examples.api.dbinsert.Row

 

getContent() - Method in class org.apache.commons.digester3.annotations.atom.Entry

 

getContent() - Method in class org.apache.commons.digester3.edsl.atom.Entry

 

getContextClassLoader() - Method in interface org.apache.commons.digester3.binder.RulesBinder

Returns the context ClassLoader.

getCopyright() - Method in class org.apache.commons.digester3.rss.Channel

 

getCount() - Method in class org.apache.commons.digester3.Digester

Return the current depth of the element stack.

getCountry() - Method in class org.apache.commons.digester3.examples.api.addressbook.Address

Returns the value of country.

getCountry() - Method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Address

Returns the value of country.

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

getDescription() - Method in class org.apache.commons.digester3.rss.Channel

 

getDescription() - Method in class org.apache.commons.digester3.rss.Image

 

getDescription() - Method in class org.apache.commons.digester3.rss.Item

 

getDescription() - Method in class org.apache.commons.digester3.rss.TextInput

 

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.

getDocs() - Method in class org.apache.commons.digester3.rss.Channel

 

getDocumentLocator() - Method in class org.apache.commons.digester3.binder.DigesterLoader

Gets the document locator associated with our parser.

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.

getEntries() - Method in class org.apache.commons.digester3.annotations.atom.Feed

 

getEntries() - Method in class org.apache.commons.digester3.edsl.atom.Feed

 

getErrorHandler() - Method in class org.apache.commons.digester3.binder.DigesterLoader

Return the error handler for this Digester.

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.

getHeight() - Method in class org.apache.commons.digester3.rss.Image

 

getId() - Method in class org.apache.commons.digester3.annotations.atom.Entry

 

getId() - Method in class org.apache.commons.digester3.annotations.atom.Feed

 

getId() - Method in class org.apache.commons.digester3.edsl.atom.Entry

 

getId() - Method in class org.apache.commons.digester3.edsl.atom.Feed

 

getId() - Method in class org.apache.commons.digester3.plugins.Declaration

Return the id associated with this declaration.

getImage() - Method in class org.apache.commons.digester3.rss.Channel

 

getImageClass() - Method in class org.apache.commons.digester3.rss.RSSDigester

 

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

getItemClass() - Method in class org.apache.commons.digester3.rss.RSSDigester

 

getItems() - Method in class org.apache.commons.digester3.rss.Channel

Return the items for this channel.

getLanguage() - Method in class org.apache.commons.digester3.rss.Channel

 

getLastBuildDate() - Method in class org.apache.commons.digester3.rss.Channel

 

getLength() - Method in class org.apache.commons.digester3.substitution.VariableAttributes

getLink() - Method in class org.apache.commons.digester3.annotations.atom.Entry

 

getLink() - Method in class org.apache.commons.digester3.annotations.atom.Feed

 

getLink() - Method in class org.apache.commons.digester3.edsl.atom.Entry

 

getLink() - Method in class org.apache.commons.digester3.edsl.atom.Feed

 

getLink() - Method in class org.apache.commons.digester3.rss.Channel

 

getLink() - Method in class org.apache.commons.digester3.rss.Image

 

getLink() - Method in class org.apache.commons.digester3.rss.Item

 

getLink() - Method in class org.apache.commons.digester3.rss.TextInput

 

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

getManagingEditor() - Method in class org.apache.commons.digester3.rss.Channel

 

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().

getName() - Method in class org.apache.commons.digester3.examples.api.dbinsert.Row.Column

 

getName() - Method in class org.apache.commons.digester3.examples.api.dbinsert.Table

 

getName() - Method in class org.apache.commons.digester3.rss.TextInput

 

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.

getPubDate() - Method in class org.apache.commons.digester3.rss.Channel

 

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

getRating() - Method in class org.apache.commons.digester3.rss.Channel

 

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.

getSkipDays() - Method in class org.apache.commons.digester3.rss.Channel

Return the skip days for this channel.

getSkipHours() - Method in class org.apache.commons.digester3.rss.Channel

Return the skip hours for this channel.

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.

getState() - Method in class org.apache.commons.digester3.examples.api.addressbook.Address

Returns the value of state.

getState() - Method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Address

Returns the value of state.

getStreet() - Method in class org.apache.commons.digester3.examples.api.addressbook.Address

Returns the value of street.

getStreet() - Method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Address

Returns the value of street.

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.

getTextInput() - Method in class org.apache.commons.digester3.rss.Channel

 

getTextInputClass() - Method in class org.apache.commons.digester3.rss.RSSDigester

 

getTitle() - Method in class org.apache.commons.digester3.annotations.atom.Entry

 

getTitle() - Method in class org.apache.commons.digester3.annotations.atom.Feed

 

getTitle() - Method in class org.apache.commons.digester3.edsl.atom.Entry

 

getTitle() - Method in class org.apache.commons.digester3.edsl.atom.Feed

 

getTitle() - Method in class org.apache.commons.digester3.rss.Channel

 

getTitle() - Method in class org.apache.commons.digester3.rss.Image

 

getTitle() - Method in class org.apache.commons.digester3.rss.Item

 

getTitle() - Method in class org.apache.commons.digester3.rss.TextInput

 

getTrimData() - Method in class org.apache.commons.digester3.SetNestedPropertiesRule

Return the flag to have leading and trailing whitespace removed.

getType() - Method in class org.apache.commons.digester3.examples.api.addressbook.Address

Returns the value of type.

getType() - Method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Address

Returns the value of type.

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

getUpdated() - Method in class org.apache.commons.digester3.annotations.atom.Entry

 

getUpdated() - Method in class org.apache.commons.digester3.annotations.atom.Feed

 

getUpdated() - Method in class org.apache.commons.digester3.edsl.atom.Entry

 

getUpdated() - Method in class org.apache.commons.digester3.edsl.atom.Feed

 

getURI(int) - Method in class org.apache.commons.digester3.substitution.VariableAttributes

getURL() - Method in class org.apache.commons.digester3.rss.Image

 

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() - Method in class org.apache.commons.digester3.examples.api.dbinsert.Row.Column

 

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

getVersion() - Method in class org.apache.commons.digester3.rss.Channel

 

getWebMaster() - Method in class org.apache.commons.digester3.rss.Channel

 

getWidth() - Method in class org.apache.commons.digester3.rss.Image

 

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.

getZip() - Method in class org.apache.commons.digester3.examples.api.addressbook.Address

Returns the value of zip.

getZip() - Method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Address

Returns the value of zip.

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, AnnotatedElement, 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.

height - Variable in class org.apache.commons.digester3.rss.Image

The image height in pixels (1-400).

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.

image - Variable in class org.apache.commons.digester3.rss.Channel

The image describing this channel.

Image - Class in org.apache.commons.digester3.rss

Implementation object representing an image in the Rich Site Summary DTD, version 0.91.

Image() - Constructor for class org.apache.commons.digester3.rss.Image

 

imageClass - Variable in class org.apache.commons.digester3.rss.RSSDigester

The fully qualified class name of the Image implementation class.

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 DOCTYPE validation parser flag.

isXIncludeAware() - Method in class org.apache.commons.digester3.binder.DigesterLoader

Return the XInclude-aware flag for parsers we create;

Item - Interface in org.apache.commons.digester3.examples.api.catalog

See Main.java.

Item - Class in org.apache.commons.digester3.rss

Implementation object representing an item in the Rich Site Summary DTD, version 0.91.

Item() - Constructor for class org.apache.commons.digester3.rss.Item

 

itemClass - Variable in class org.apache.commons.digester3.rss.RSSDigester

The fully qualified class name of the Item implementation class.

items - Variable in class org.apache.commons.digester3.rss.Channel

The set of items associated with this Channel.

L

language - Variable in class org.apache.commons.digester3.rss.Channel

The channel language (2-5 characters).

lastBuildDate - Variable in class org.apache.commons.digester3.rss.Channel

The channel last build date (1-100 characters).

link - Variable in class org.apache.commons.digester3.rss.Channel

The channel link (1-500 characters).

link - Variable in class org.apache.commons.digester3.rss.Image

The image link (1-500 characters).

link - Variable in class org.apache.commons.digester3.rss.Item

The item link (1-500 characters).

link - Variable in class org.apache.commons.digester3.rss.TextInput

The text input link (1-500 characters).

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

Main - Class in org.apache.commons.digester3.annotations.atom

 

Main() - Constructor for class org.apache.commons.digester3.annotations.atom.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.annotations.atom.Main

 

Main - Class in org.apache.commons.digester3.edsl.atom

 

Main() - Constructor for class org.apache.commons.digester3.edsl.atom.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.edsl.atom.Main

 

Main - Class in org.apache.commons.digester3.examples.api.addressbook

A simple program to demonstrate the basic functionality of the Commons Digester module.

Main() - Constructor for class org.apache.commons.digester3.examples.api.addressbook.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.examples.api.addressbook.Main

Main method : entry point for running this example program.

Main - Class in org.apache.commons.digester3.examples.api.catalog

A simple program to demonstrate some of the functionality of the Commons Digester module.

Main() - Constructor for class org.apache.commons.digester3.examples.api.catalog.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.examples.api.catalog.Main

Main method : entry point for running this example program.

Main - Class in org.apache.commons.digester3.examples.api.dbinsert

A simple program to demonstrate that the Commons Digester module can be used to trigger actions as the xml is parsed, rather than just build up in-memory representations of the parsed data.

Main() - Constructor for class org.apache.commons.digester3.examples.api.dbinsert.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.examples.api.dbinsert.Main

Main method : entry point for running this example program.

Main - Class in org.apache.commons.digester3.examples.api.documentmarkup

A simple "test harness" which demonstrates how the MarkupDigester class (plus the supporting interface/rule classes) can process "document-markup" style xml data.

Main() - Constructor for class org.apache.commons.digester3.examples.api.documentmarkup.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.examples.api.documentmarkup.Main

See the run method.

main(String[]) - Static method in class org.apache.commons.digester3.examples.plugins.pipeline.Pipeline

 

Main - Class in org.apache.commons.digester3.examples.xmlrules.addressbook

A simple program to demonstrate the basic functionality of the Commons Digester module with the xmlrules extension.

Main() - Constructor for class org.apache.commons.digester3.examples.xmlrules.addressbook.Main

 

main(String[]) - Static method in class org.apache.commons.digester3.examples.xmlrules.addressbook.Main

Main method : entry point for running this example program.

main(String[]) - Static method in class org.apache.commons.digester3.rss.RSSDigester

Test main program that parses the channel description included in this package as a static resource.

managingEditor - Variable in class org.apache.commons.digester3.rss.Channel

The managing editor (1-100 characters).

MarkupDigester - Class in org.apache.commons.digester3.examples.api.documentmarkup

This is a subclass of digester which supports rules which implement the TextSegmentHandler interface, causing the "textSegment" method on each matching rule (of the appropriate type) to be invoked when an element contains a segment of text followed by a child element.

MarkupDigester() - Constructor for class org.apache.commons.digester3.examples.api.documentmarkup.MarkupDigester

See equivalent constructor in Digester class.

MarkupDigester(SAXParser) - Constructor for class org.apache.commons.digester3.examples.api.documentmarkup.MarkupDigester

See equivalent constructor in Digester class.

MarkupDigester(XMLReader) - Constructor for class org.apache.commons.digester3.examples.api.documentmarkup.MarkupDigester

See equivalent constructor in Digester class.

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.

methodName - Variable in class org.apache.commons.digester3.examples.api.documentmarkup.SetTextSegmentRule

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.rss.TextInput

The text input field name (1-100 characters).

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.atom - package org.apache.commons.digester3.annotations.atom

 

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.edsl.atom - package org.apache.commons.digester3.edsl.atom

 

org.apache.commons.digester3.examples.api.addressbook - package org.apache.commons.digester3.examples.api.addressbook

 

org.apache.commons.digester3.examples.api.catalog - package org.apache.commons.digester3.examples.api.catalog

 

org.apache.commons.digester3.examples.api.dbinsert - package org.apache.commons.digester3.examples.api.dbinsert

 

org.apache.commons.digester3.examples.api.documentmarkup - package org.apache.commons.digester3.examples.api.documentmarkup

 

org.apache.commons.digester3.examples.plugins.pipeline - package org.apache.commons.digester3.examples.plugins.pipeline

 

org.apache.commons.digester3.examples.xmlrules.addressbook - package org.apache.commons.digester3.examples.xmlrules.addressbook

 

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.rss - package org.apache.commons.digester3.rss

Example usage of Digester to parse XML documents compatible with the Rich Site Summary format used by many newsfeeds.

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.