org.apache.commons.digester.plugins.strategies
Class FinderFromFile
java.lang.Object
|
+--org.apache.commons.digester.plugins.RuleFinder
|
+--org.apache.commons.digester.plugins.strategies.FinderFromFile
- public class FinderFromFile
- extends RuleFinder
A rule-finding algorithm which expects the user to specify an absolute
or relative path in the plugin declaration.
The file is expected to contain Digester rules in xmlrules format.
- Since:
- 1.6
Field Summary |
static java.lang.String |
DFLT_FILENAME_ATTR
Xml attribute that needs to be present on a plugin declaration
in order to specify the file to load rules from. |
Method Summary |
RuleLoader |
findLoader(Digester d,
java.lang.Class pluginClass,
java.util.Properties p)
If there exists a property with the name 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_FILENAME_ATTR
public static java.lang.String DFLT_FILENAME_ATTR
- Xml attribute that needs to be present on a plugin declaration
in order to specify the file to load rules from.
FinderFromFile
public FinderFromFile()
- See
findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties)
.
FinderFromFile
public FinderFromFile(java.lang.String filenameAttr)
- 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 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 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.
Copyright © 2001-2006 The Apache Software Foundation. All Rights Reserved.