| java.lang.Object
 org.apache.commons.digester.plugins.PluginRules
| PluginRules | | public class PluginRules implements Rules(Code) | | A custom digester Rules manager which must be used as the Rules object
when using the plugins module functionality.
During parsing, a linked list of PluginCreateRule instances develop, and
this list also acts like a stack. The original instance that was set before
the Digester started parsing is always at the tail of the list, and the
Digester always holds a reference to the instance at the head of the list
in the rules member. Initially, this list/stack holds just one instance,
ie head and tail are the same object.
When the start of an xml element causes a PluginCreateRule to fire, a new
PluginRules instance is created and inserted at the head of the list (ie
pushed onto the stack of Rules objects). Digester.getRules() therefore
returns this new Rules object, and any custom rules associated with that
plugin are added to that instance.
When the end of the xml element is encountered (and therefore the
PluginCreateRule end method fires), the stack of Rules objects is popped,
so that Digester.getRules returns the previous Rules object.
since:
1.6 |
| Field Summary | |
| protected Digester | digester
The Digester instance with which this Rules instance is associated. |
| Constructor Summary | |
| public | PluginRules()
Constructor for top-level Rules objects. | | public | PluginRules(Rules decoratedRules)
Constructor for top-level Rules object which handles rule-matching
using the specified implementation. | | | PluginRules(Digester digester, String mountPoint, PluginRules parent, Class pluginClass)
Constructs a Rules instance which has a parent Rules object
(which is different from having a delegate rules object). |
| digester | | protected Digester digester(Code) | | The Digester instance with which this Rules instance is associated.
|
| PluginRules | | public PluginRules()(Code) | | Constructor for top-level Rules objects. Exactly one of these must
be created and installed into the Digester instance as the Rules
object before parsing starts.
|
| PluginRules | | public PluginRules(Rules decoratedRules)(Code) | | Constructor for top-level Rules object which handles rule-matching
using the specified implementation.
|
| PluginRules | | PluginRules(Digester digester, String mountPoint, PluginRules parent, Class pluginClass) throws PluginException(Code) | | Constructs a Rules instance which has a parent Rules object
(which is different from having a delegate rules object).
One of these is created each time a PluginCreateRule's begin method
fires, in order to manage the custom rules associated with whatever
concrete plugin class the user has specified.
Parameters:
digester - is the object this rules will be associated with.
Parameters:
mountPoint - is the digester match path for the element matching a PluginCreateRule which caused this "nested parsing scope"to begin. This is expected to be equal to digester.getMatch().
Parameters:
parent - must be non-null.
Parameters:
pluginClass - is the plugin class whose custom rules will beloaded into this new PluginRules object. |
| add | | public void add(String pattern, Rule rule)(Code) | | Register a new Rule instance matching the specified pattern.
Parameters:
pattern - Nesting pattern to be matched for this Rule.This parameter treats equally patterns that begin with and withouta leading slash ('/').
Parameters:
rule - Rule instance to be registered |
| clear | | public void clear()(Code) | | Clear all rules.
|
| getDecoratedRules | | Rules getDecoratedRules()(Code) | | This package-scope method is used by the PluginCreateRule class to
get direct access to the rules that were dynamically added by the
plugin. No other class should need access to this object.
|
| getDigester | | public Digester getDigester()(Code) | | Return the Digester instance with which this instance is associated.
|
| getNamespaceURI | | public String getNamespaceURI()(Code) | | Return the namespace URI that will be applied to all subsequently
added Rule objects.
|
| getParent | | public Rules getParent()(Code) | | Return the parent Rules object.
|
| getPluginManager | | public PluginManager getPluginManager()(Code) | | Return the object which "knows" about all declared plugins.
The pluginManager value |
| getRulesFactory | | public RulesFactory getRulesFactory()(Code) | | Return the rules factory object (or null if one has not been specified).
|
| match | | public List match(String path)(Code) | | Return a List of all registered Rule instances that match the specified
nesting pattern, or a zero-length List if there are no matches. If more
than one Rule instance matches, they must be returned
in the order originally registered through the add()
method.
Parameters:
path - the path to the xml nodes to be matched. |
| match | | public List match(String namespaceURI, String path)(Code) | | Return a List of all registered Rule instances that match the specified
nodepath, or a zero-length List if there are no matches. If more
than one Rule instance matches, they must be returned
in the order originally registered through the add()
method.
Parameters:
namespaceURI - Namespace URI for which to select matching rules,or null to match regardless of namespace URI
Parameters:
path - the path to the xml nodes to be matched. |
| rules | | public List rules()(Code) | | Return the list of rules registered with this object, in the order
they were registered with this object.
Note that Rule objects stored in parent Rules objects are not
returned by this method.
list of all Rule objects known to this Rules instance. |
| setDigester | | public void setDigester(Digester digester)(Code) | | Set the Digester instance with which this Rules instance is associated.
Parameters:
digester - The newly associated Digester instance |
| setNamespaceURI | | public void setNamespaceURI(String namespaceURI)(Code) | | Set the namespace URI that will be applied to all subsequently
added Rule objects.
Parameters:
namespaceURI - Namespace URI that must match on allsubsequently added rules, or null for matchingregardless of the current namespace URI |
| setRulesFactory | | public void setRulesFactory(RulesFactory factory)(Code) | | Set the object which is used to generate the new Rules instances created
to hold and process the rules associated with each plugged-in class.
|
|
|