| Package | Description |
|---|---|
| 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 |
The
plugins.strategies package contains "rule-finding" strategy
classes, and their associated "helper" loader classes. |
| Modifier and Type | Class and Description |
|---|---|
class |
PluginInvalidInputException
Thrown when an error occurs due to bad data in the file being parsed.
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
RuleLoader.addRules(Digester d,
String path)
Configures the digester with custom rules for some plugged-in class.
|
void |
Declaration.configure(Digester digester,
String pattern)
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.
|
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.
|
RuleLoader |
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).
|
void |
Declaration.init(Digester digester,
PluginManager pm)
Must be called exactly once, and must be called before any call to the configure method.
|
abstract Rules |
RulesFactory.newRules(Digester d,
Class<?> pluginClass)
Return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing
rules.
|
| Modifier and Type | Method and Description |
|---|---|
void |
LoaderFromClass.addRules(Digester d,
String path)
Configures the digester with custom rules for some plugged-in class.
|
void |
LoaderFromStream.addRules(Digester d,
String path)
Configures the digester with custom rules for some plugged-in class.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
RuleLoader |
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.
|
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);. |
| Constructor and Description |
|---|
LoaderFromClass(Class<?> rulesClass,
String methodName)
Constructor.
|
Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.