|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.digester.plugins.RuleFinder org.apache.commons.digester.plugins.strategies.FinderFromResource
public class FinderFromResource
A rule-finding algorithm which expects the user to specify a resource name (ie a file in the classpath). The file is expected to contain Digester rules in xmlrules format.
Field Summary | |
---|---|
static java.lang.String |
DFLT_RESOURCE_ATTR
Name of xml attribute on the plugin declaration which is used to configure rule-loading for that declaration. |
Constructor Summary | |
---|---|
FinderFromResource()
Constructor. |
|
FinderFromResource(java.lang.String resourceAttr)
See findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties) . |
Method Summary | |
---|---|
RuleLoader |
findLoader(Digester d,
java.lang.Class pluginClass,
java.util.Properties p)
If there exists a property with the name matching constructor param resourceAttr, then load that file, run it through the xmlrules module and return an object encapsulating those rules. |
static RuleLoader |
loadRules(Digester d,
java.lang.Class pluginClass,
java.io.InputStream is,
java.lang.String resourceName)
Open the specified resource file (ie a file in the classpath, including being within a jar in the classpath), run it through the xmlrules module and return an object encapsulating those rules. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String DFLT_RESOURCE_ATTR
Constructor Detail |
---|
public FinderFromResource()
public FinderFromResource(java.lang.String resourceAttr)
findLoader(org.apache.commons.digester.Digester, java.lang.Class, java.util.Properties)
.
Method Detail |
---|
public RuleLoader findLoader(Digester d, java.lang.Class pluginClass, java.util.Properties p) throws PluginException
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.
findLoader
in class RuleFinder
PluginException
public static RuleLoader loadRules(Digester d, java.lang.Class pluginClass, java.io.InputStream is, java.lang.String resourceName) throws PluginException
d
- is the digester into which rules will eventually be loaded.pluginClass
- is the class whose xml params the rules are parsing.is
- is where the xmlrules will be read from, and must be non-null.resourceName
- is a string describing the source of the xmlrules,
for use in generating error messages.
PluginException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |