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 String
DFLT_RESOURCE_SUFFIX
private String
resourceSuffix

Constructor Summary

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

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.

Methods inherited from class org.apache.commons.digester.plugins.RuleFinder

findLoader

Field Details

DFLT_RESOURCE_SUFFIX

public static String DFLT_RESOURCE_SUFFIX


resourceSuffix

private String resourceSuffix

Constructor Details

FinderFromDfltResource

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

findLoader

public RuleLoader findLoader(Digester d,
                             Class pluginClass,
                             Properties p)
            throws PluginException
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.

Overrides:
findLoader in interface RuleFinder


Copyright (c) 2001-2004 - Apache Software Foundation