Save This Page
Home » commons-digester-1.8-src » org.apache.commons » digester » plugins » strategies » [javadoc | source]
org.apache.commons.digester.plugins.strategies
public class: FinderFromDfltResource [javadoc | source]
java.lang.Object
   org.apache.commons.digester.plugins.RuleFinder
      org.apache.commons.digester.plugins.strategies.FinderFromDfltResource
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.

Field Summary
public static  String DFLT_RESOURCE_SUFFIX     
Constructor:
 public 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 from org.apache.commons.digester.plugins.strategies.FinderFromDfltResource Summary:
findLoader
Methods from org.apache.commons.digester.plugins.RuleFinder:
findLoader
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.commons.digester.plugins.strategies.FinderFromDfltResource Detail:
 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.