org.apache.commons.digester.plugins.strategies

Class FinderFromDfltResource

public class FinderFromDfltResource extends RuleFinder

A rule-finding algorithm which looks for a resource file in the classpath whose name is derived from the plugin class name plus a specified suffix.

If the resource-file is found, then it is expected to define a set of Digester rules in xmlrules format.

Since: 1.6

Field Summary
static StringDFLT_RESOURCE_SUFFIX
StringresourceSuffix
Constructor Summary
FinderFromDfltResource()
FinderFromDfltResource(String resourceSuffix)
Create a rule-finder which can load an xmlrules file, cache the rules away, and later add them as a plugin's custom rules when that plugin is referenced.
Method Summary
RuleLoaderfindLoader(Digester d, Class pluginClass, Properties p)
If there exists a resource file whose name is equal to the plugin class name + the suffix specified in the constructor, then load that file, run it through the xmlrules module and return an object encapsulating those rules.

Field Detail

DFLT_RESOURCE_SUFFIX

public static String DFLT_RESOURCE_SUFFIX

resourceSuffix

private String resourceSuffix

Constructor Detail

FinderFromDfltResource

public FinderFromDfltResource()
See FinderFromDfltResource.

FinderFromDfltResource

public FinderFromDfltResource(String resourceSuffix)
Create a rule-finder which can load an xmlrules file, cache the rules away, and later add them as a plugin's custom rules when that plugin is referenced.

Parameters: resourceSuffix must be non-null.

Method Detail

findLoader

public RuleLoader findLoader(Digester d, Class pluginClass, Properties p)
If there exists a resource file whose name is equal to the plugin class name + the suffix 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 such resource file, 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.