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 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.

Constructor Summary

FinderFromFile()
See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties).

FinderFromFile(String filenameAttr)
See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties).

Method Summary

RuleLoader

findLoader(Digester d, Class<?> pluginClass, 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

Field Detail

DFLT_FILENAME_ATTR

public static 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.

Constructor Detail

FinderFromFile

public FinderFromFile()

See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties).

FinderFromFile

public FinderFromFile(String filenameAttr)

See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties).

Method Detail

findLoader

public RuleLoader findLoader(Digester d,
                             Class<?> pluginClass,
                             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.

Specified by:

findLoader in class RuleFinder

Throws:

PluginException