Class FinderFromDfltResource
- java.lang.Object
-
- org.apache.commons.digester3.plugins.RuleFinder
-
- org.apache.commons.digester3.plugins.strategies.FinderFromDfltResource
-
public class FinderFromDfltResource extends RuleFinder
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.If the resource-file is found, then it is expected to define a set of Digester rules in xmlrules format.
- Since:
- 1.6
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
DFLT_RESOURCE_SUFFIX
private java.lang.String
resourceSuffix
-
Constructor Summary
Constructors Constructor Description FinderFromDfltResource()
FinderFromDfltResource(java.lang.String resourceSuffix)
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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RuleLoader
findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.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.
-
-
-
Field Detail
-
DFLT_RESOURCE_SUFFIX
private static final java.lang.String DFLT_RESOURCE_SUFFIX
- See Also:
- Constant Field Values
-
resourceSuffix
private final java.lang.String resourceSuffix
-
-
Constructor Detail
-
FinderFromDfltResource
public FinderFromDfltResource()
-
FinderFromDfltResource
public FinderFromDfltResource(java.lang.String resourceSuffix)
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.- Parameters:
resourceSuffix
- must be non-null.
-
-
Method Detail
-
findLoader
public RuleLoader findLoader(Digester d, java.lang.Class<?> pluginClass, java.util.Properties p) throws PluginException
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.If there is no such resource file, then just return null.
The returned object (when non-null) will add the selected rules to the digester whenever its addRules method is invoked.
- Specified by:
findLoader
in classRuleFinder
- Parameters:
d
- 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.
-
-