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 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.
private String
filenameAttr
See findLoader(Digester,Class,Properties).

Constructor Summary

FinderFromFile()
See findLoader(Digester,Class,Properties).
FinderFromFile(String filenameAttr)
See findLoader(Digester,Class,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 org.apache.commons.digester.plugins.RuleFinder

findLoader

Field Details

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

Constructor Details

FinderFromFile

public FinderFromFile()

FinderFromFile

public FinderFromFile(String filenameAttr)

Method Details

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.

Overrides:
findLoader in interface RuleFinder

Copyright 2001-2005 The Apache Software Foundation.