Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.commons.digester.plugins

Class PluginDeclarationRule

public class PluginDeclarationRule
extends Rule
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.

Since:
1.6

Field Summary

Fields inherited from class org.apache.commons.digester.Rule

digester, namespaceURI

Constructor Summary

PluginDeclarationRule()
constructor

Method Summary

void
begin(String namespace, String name, org.xml.sax.Attributes attributes)
Invoked upon reading a tag defining a plugin declaration.
static void
declarePlugin(Digester digester, Properties props)

Methods inherited from class org.apache.commons.digester.Rule

begin, begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI

Constructor Details

PluginDeclarationRule

public PluginDeclarationRule()
constructor

Method Details

begin

public void begin(String namespace,
                  String name,
                  org.xml.sax.Attributes attributes)
            throws java.lang.Exception
Invoked upon reading a tag defining a plugin declaration. The tag must have the following mandatory attributes:
  • id
  • class
Parameters:
namespace - 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.

declarePlugin

public static void declarePlugin(Digester digester,
                                 Properties props)
            throws PluginException

Overview Package Tree Index Deprecated About
Copyright 2001-2005 The Apache Software Foundation.