org.apache.commons.digester.plugins.strategies
Class FinderFromClass

java.lang.Object
  extended by org.apache.commons.digester.plugins.RuleFinder
      extended by org.apache.commons.digester.plugins.strategies.FinderFromClass

public class FinderFromClass
extends RuleFinder

A rule-finding algorithm which expects the caller to specify a classname and methodname as plugin properties.

Since:
1.6

Field Summary
static java.lang.String DFLT_METHOD_ATTR
           
static java.lang.String DFLT_METHOD_NAME
           
static java.lang.String DFLT_RULECLASS_ATTR
           
 
Constructor Summary
FinderFromClass()
          See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties).
FinderFromClass(java.lang.String ruleClassAttr, java.lang.String methodAttr, java.lang.String dfltMethodName)
          Create a rule-finder which invokes a user-specified method on a user-specified class whenever dynamic rules for a plugin need to be loaded.
 
Method Summary
 RuleLoader findLoader(Digester digester, java.lang.Class pluginClass, java.util.Properties p)
          If there exists a property with the name matching constructor param ruleClassAttr, then load the specified class, locate the appropriate rules-adding method on that class, and return an object encapsulating that info.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DFLT_RULECLASS_ATTR

public static java.lang.String DFLT_RULECLASS_ATTR

DFLT_METHOD_ATTR

public static java.lang.String DFLT_METHOD_ATTR

DFLT_METHOD_NAME

public static java.lang.String DFLT_METHOD_NAME
Constructor Detail

FinderFromClass

public FinderFromClass()
See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties).


FinderFromClass

public FinderFromClass(java.lang.String ruleClassAttr,
                       java.lang.String methodAttr,
                       java.lang.String dfltMethodName)
Create a rule-finder which invokes a user-specified method on a user-specified class whenever dynamic rules for a plugin need to be loaded. See the findRules method for more info.

Parameters:
ruleClassAttr - must be non-null.
methodAttr - may be null.
dfltMethodName - may be null.
Method Detail

findLoader

public RuleLoader findLoader(Digester digester,
                             java.lang.Class pluginClass,
                             java.util.Properties p)
                      throws PluginException
If there exists a property with the name matching constructor param ruleClassAttr, then load the specified class, locate the appropriate rules-adding method on that class, and return an object encapsulating that info.

If there is no matching property provided, then just return null.

The returned object (when non-null) will invoke the target method on the selected class whenever its addRules method is invoked. The target method is expected to have the following prototype: public static void xxxxx(Digester d, String patternPrefix);

The target method can be specified in several ways. If this object's constructor was passed a non-null methodAttr parameter, and the properties defines a value with that key, then that is taken as the target method name. If there is no matching property, or the constructor was passed null for methodAttr, then the dfltMethodName passed to the constructor is used as the name of the method on the target class. And if that was null, then DFLT_METHOD_NAME will be used.

When the user explicitly declares a plugin in the input xml, the xml attributes on the declaration tag are passed here as properties, so the user can select any class in the classpath (and any method on that class provided it has the correct prototype) as the source of dynamic rules for the plugged-in class.

Specified by:
findLoader in class RuleFinder
Throws:
PluginException


Copyright © 2001-2005 The Apache Software Foundation. All Rights Reserved.