org.apache.commons.digester.plugins.strategies
Class FinderFromDfltResource
java.lang.Object
|
+--org.apache.commons.digester.plugins.RuleFinder
|
+--org.apache.commons.digester.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
Method Summary |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DFLT_RESOURCE_SUFFIX
public static java.lang.String DFLT_RESOURCE_SUFFIX
FinderFromDfltResource
public FinderFromDfltResource()
- See
findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties)
.
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.
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.
- Overrides:
findLoader
in class RuleFinder
- Following copied from class:
org.apache.commons.digester.plugins.RuleFinder
- Throws:
PluginConfigurationException
- if the algorithm finds a source
of rules, but there is something invalid about that source.
Copyright © 2001-2006 The Apache Software Foundation. All Rights Reserved.