|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.digester3.Rule
org.apache.commons.digester3.plugins.PluginDeclarationRule
public class PluginDeclarationRule
A Digester rule which allows the user to pre-declare a class which is to be referenced later at a plugin point by a PluginCreateRule.
Normally, a PluginDeclarationRule is added to a Digester instance with the pattern "{root}/plugin" or "* /plugin" where {root} is the name of the root tag in the input document.
| Constructor Summary | |
|---|---|
PluginDeclarationRule()
constructor |
|
| Method Summary | |
|---|---|
void |
begin(String namespace,
String name,
Attributes attributes)
Invoked upon reading a tag defining a plugin declaration. |
static void |
declarePlugin(Digester digester,
Properties props)
Helper method to declare a plugin inside the given Digester. |
| Methods inherited from class org.apache.commons.digester3.Rule |
|---|
body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PluginDeclarationRule()
| Method Detail |
|---|
public void begin(String namespace,
String name,
Attributes attributes)
throws Exception
begin in class Rulenamespace - The xml namespace in which the xml element which triggered this rule resides.name - The name of the xml element which triggered this rule.attributes - The set of attributes on the xml element which triggered this rule.
Exception - if any error occurs
public static void declarePlugin(Digester digester,
Properties props)
throws PluginException
digester - The Digester instance to declare pluginprops - the properties where extracting plugin attributes
PluginException - if any error occurs while declaring the plugin
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||