Class FinderFromDfltClass
java.lang.Object
org.apache.commons.digester3.plugins.RuleFinder
org.apache.commons.digester3.plugins.strategies.FinderFromDfltClass
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.
- Since:
- 1.6
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFinderFromDfltClass
(String rulesClassSuffix, String methodName) Create a rule-finder which invokes a method on a class whenever dynamic rules for a plugin need to be loaded. -
Method Summary
Modifier and TypeMethodDescriptionfindLoader
(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.
-
Field Details
-
DFLT_RULECLASS_SUFFIX
- See Also:
-
DFLT_METHOD_NAME
- See Also:
-
rulesClassSuffix
-
methodName
-
-
Constructor Details
-
FinderFromDfltClass
public FinderFromDfltClass() -
FinderFromDfltClass
Create a rule-finder which invokes a method on a class whenever dynamic rules for a plugin need to be loaded. See the findRules method for more info.- Parameters:
rulesClassSuffix
- must be non-null.methodName
- may be null.
-
-
Method Details
-
findLoader
public RuleLoader findLoader(Digester digester, Class<?> pluginClass, Properties p) throws PluginException 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.If there is no such class, then just return null.
The returned object (when non-null) will invoke the target method on the selected class whenever its addRules method is invoked. The target method is expected to have the following prototype:
public static void xxxxx(Digester d, String patternPrefix);
- Specified by:
findLoader
in classRuleFinder
- Parameters:
digester
- The digester instance where locating plugin classespluginClass
- The plugin Java classp
- The properties object that holds any xml attributes the user may have specified on the plugin declaration in order to indicate how to locate the plugin rules.- Returns:
- a source of digester rules for the specified plugin class.
- Throws:
PluginException
- if the algorithm finds a source of rules, but there is something invalid about that source.
-