Uses of Class
org.apache.commons.digester3.plugins.PluginException
Packages that use PluginException
Package
Description
The
plugins
package provides an easy mechanism whereby new
digestion rules can be added dynamically during a digestion.The
plugins.strategies
package contains "rule-finding" strategy
classes, and their associated "helper" loader classes.-
Uses of PluginException in org.apache.commons.digester3.plugins
Subclasses of PluginException in org.apache.commons.digester3.pluginsModifier and TypeClassDescriptionclass
Thrown when an error occurs due to bad data in the file being parsed.Methods in org.apache.commons.digester3.plugins that throw PluginExceptionModifier and TypeMethodDescriptionabstract void
Configures the digester with custom rules for some plugged-in class.void
Attempt to load custom rules for the target class at the specified pattern.static void
PluginDeclarationRule.declarePlugin
(Digester digester, Properties props) Helper method to declare a plugin inside the given Digester.PluginManager.findLoader
(Digester digester, String id, Class<?> pluginClass, Properties props) Given a plugin class and some associated properties, scan the list of known RuleFinder instances until one detects a source of custom rules for this plugin (aka a RuleLoader).abstract RuleLoader
RuleFinder.findLoader
(Digester d, Class<?> pluginClass, Properties p) Apply the finder algorithm to attempt to locate a source of digester rules for the specified plugin class.void
Declaration.init
(Digester digester, PluginManager pm) Must be called exactly once, and must be called before any call to the configure method.abstract Rules
Return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing rules.Constructors in org.apache.commons.digester3.plugins that throw PluginExceptionModifierConstructorDescription(package private)
PluginRules
(Digester digester, String mountPoint, PluginRules parent, Class<?> pluginClass) Constructs a Rules instance which has a parent Rules object (which is different from having a delegate rules object). -
Uses of PluginException in org.apache.commons.digester3.plugins.strategies
Methods in org.apache.commons.digester3.plugins.strategies that throw PluginExceptionModifier and TypeMethodDescriptionvoid
Configures the digester with custom rules for some plugged-in class.void
Configures the digester with custom rules for some plugged-in class.FinderFromClass.findLoader
(Digester digester, Class<?> pluginClass, Properties p) If there exists a property with the name matching constructor param ruleClassAttr, then load the specified class, locate the appropriate rules-adding method on that class, and return an object encapsulating that info.FinderFromDfltClass.findLoader
(Digester digester, Class<?> pluginClass, Properties p) If there exists a class whose name is the plugin class name + the suffix specified to the constructor, then load that class, locate the appropriate rules-adding method on that class, and return an object encapsulating that info.FinderFromDfltMethod.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists on the plugin class a method with name matching the constructor's methodName value then locate the appropriate Method on the plugin class and return an object encapsulating that info.FinderFromDfltResource.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a resource file whose name is equal to the plugin class name + the suffix specified in the constructor, then load that file, run it through the xmlrules module and return an object encapsulating those rules.FinderFromFile.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a property with the name specified in the constructor, then load that file, run it through the xmlrules module and return an object encapsulating those rules.FinderFromMethod.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a property with the name matching constructor param methodAttr, then locate the appropriate Method on the plugin class and return an object encapsulating that info.FinderFromResource.findLoader
(Digester d, Class<?> pluginClass, Properties p) If there exists a property with the name matching constructor param resourceAttr, then load that file, run it through the xmlrules module and return an object encapsulating those rules.FinderSetProperties.findLoader
(Digester d, Class<?> pluginClass, Properties p) Returns a RuleLoader unless the properties contain an entry with the name matching constructor param propsAttr, and the value matching what is in falseval.static RuleLoader
FinderFromResource.loadRules
(Digester d, Class<?> pluginClass, InputStream is, String resourceName) Open the specified resource file (ie a file in the classpath, including being within a jar in the classpath), run it through the xmlrules module and return an object encapsulating those rules.static Method
LoaderFromClass.locateMethod
(Class<?> rulesClass, String methodName) Find a method on the specified class whose name matches methodName, and whose signature is:public static void foo(Digester d, String patternPrefix);
.Constructors in org.apache.commons.digester3.plugins.strategies that throw PluginExceptionModifierConstructorDescriptionLoaderFromClass
(Class<?> rulesClass, String methodName) Constructor.