public class FinderFromDfltResource extends RuleFinder
If the resource-file is found, then it is expected to define a set of Digester rules in xmlrules format.
| Constructor and Description |
|---|
FinderFromDfltResource()
|
FinderFromDfltResource(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.
|
| Modifier and Type | Method and Description |
|---|---|
RuleLoader |
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.
|
public FinderFromDfltResource()
public FinderFromDfltResource(String resourceSuffix)
resourceSuffix - must be non-null.public RuleLoader findLoader(Digester d, Class<?> pluginClass, Properties p) throws PluginException
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.
findLoader in class RuleFinderd - 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.PluginException - if the algorithm finds a source of rules, but there is something invalid
about that source.Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.