org.apache.commons.digester.plugins.strategies
Class FinderFromResource
java.lang.Object
|
+--org.apache.commons.digester.plugins.RuleFinder
|
+--org.apache.commons.digester.plugins.strategies.FinderFromResource
- public class FinderFromResource
- extends RuleFinder
A rule-finding algorithm which expects the user to specify a resource
name (ie a file in the classpath). The file is expected to contain Digester
rules in xmlrules format.
- Since:
- 1.6
Field Summary |
static java.lang.String |
DFLT_RESOURCE_ATTR
Name of xml attribute on the plugin declaration which is used
to configure rule-loading for that declaration. |
Method Summary |
RuleLoader |
findLoader(Digester d,
java.lang.Class pluginClass,
java.util.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. |
static RuleLoader |
loadRules(Digester d,
java.lang.Class pluginClass,
java.io.InputStream is,
java.lang.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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DFLT_RESOURCE_ATTR
public static java.lang.String DFLT_RESOURCE_ATTR
- Name of xml attribute on the plugin declaration which is used
to configure rule-loading for that declaration.
FinderFromResource
public FinderFromResource()
- Constructor.
FinderFromResource
public FinderFromResource(java.lang.String resourceAttr)
- See
findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties)
.
findLoader
public RuleLoader findLoader(Digester d,
java.lang.Class pluginClass,
java.util.Properties p)
throws PluginException
- 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.
If there is no matching property provided, 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.
loadRules
public static RuleLoader loadRules(Digester d,
java.lang.Class pluginClass,
java.io.InputStream is,
java.lang.String resourceName)
throws PluginException
- 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.
- Parameters:
d
- is the digester into which rules will eventually be loaded.pluginClass
- is the class whose xml params the rules are parsing.is
- is where the xmlrules will be read from, and must be non-null.resourceName
- is a string describing the source of the xmlrules,
for use in generating error messages.
Copyright © 2001-2006 The Apache Software Foundation. All Rights Reserved.