org.apache.commons.digester.plugins.strategies

Class 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 StringDFLT_FILENAME_ATTR
Xml attribute that needs to be present on a plugin declaration in order to specify the file to load rules from.
StringfilenameAttr
Constructor Summary
FinderFromFile()
FinderFromFile(String filenameAttr)
Method Summary
RuleLoaderfindLoader(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.

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.

filenameAttr

private String filenameAttr
See FinderFromFile.

Constructor Detail

FinderFromFile

public FinderFromFile()
See FinderFromFile.

FinderFromFile

public FinderFromFile(String filenameAttr)
See FinderFromFile.

Method Detail

findLoader

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

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.

Copyright 2001-2005 The Apache Software Foundation.