| java.lang.Object
 org.apache.commons.digester.AbstractRulesImpl
All known Subclasses: org.apache.commons.digester.RegexRules,
| AbstractRulesImpl | | abstract public class AbstractRulesImpl implements Rules(Code) | | AbstractRuleImpl provides basic services for Rules implementations.
Extending this class should make it easier to create a Rules implementation.
AbstractRuleImpl manages the Digester
and namespaceUri properties.
If the subclass overrides
AbstractRulesImpl.registerRule (rather than
AbstractRulesImpl.add ),
then the Digester and namespaceURI of the Rule
will be set correctly before it is passed to registerRule.
The subclass can then perform whatever it needs to do to register the rule.
since:
1.5 |
| Method Summary | |
| public void | add(String pattern, Rule rule)
Registers a new Rule instance matching the specified pattern. | | abstract public void | clear()
Clear all existing Rule instance registrations. | | public Digester | getDigester()
Return the Digester instance with which this Rules instance is
associated. | | public String | getNamespaceURI()
Return the namespace URI that will be applied to all subsequently
added Rule objects. | | public List | match(String pattern)
Return a List of all registered Rule instances that match the specified
nesting pattern, or a zero-length List if there are no matches. | | abstract public List | match(String namespaceURI, String pattern)
Return a List of all registered Rule instances that match the specified
nesting pattern, or a zero-length List if there are no matches. | | abstract protected void | registerRule(String pattern, Rule rule)
Register rule at given pattern. | | abstract public List | rules()
Return a List of all registered Rule instances, or a zero-length List
if there are no registered Rule instances. | | public void | setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated. | | public void | setNamespaceURI(String namespaceURI)
Set the namespace URI that will be applied to all subsequently
added Rule objects. |
| add | | public void add(String pattern, Rule rule)(Code) | | Registers a new Rule instance matching the specified pattern.
This implementation sets the Digester and the
namespaceURI on the Rule before calling
AbstractRulesImpl.registerRule .
Parameters:
pattern - Nesting pattern to be matched for this Rule
Parameters:
rule - Rule instance to be registered |
| clear | | abstract public void clear()(Code) | | Clear all existing Rule instance registrations.
|
| getDigester | | public Digester getDigester()(Code) | | Return the Digester instance with which this Rules instance is
associated.
|
| getNamespaceURI | | public String getNamespaceURI()(Code) | | Return the namespace URI that will be applied to all subsequently
added Rule objects.
|
| match | | public List match(String pattern)(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:
pattern - Nesting pattern to be matched |
| match | | abstract public List match(String namespaceURI, String pattern)(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:
namespaceURI - Namespace URI for which to select matching rules,or null to match regardless of namespace URI
Parameters:
pattern - Nesting pattern to be matched |
| registerRule | | abstract protected void registerRule(String pattern, Rule rule)(Code) | | Register rule at given pattern.
The the Digester and namespaceURI properties of the given Rule
can be assumed to have been set properly before this method is called.
Parameters:
pattern - Nesting pattern to be matched for this Rule
Parameters:
rule - Rule instance to be registered |
| rules | | abstract public List rules()(Code) | | Return a List of all registered Rule instances, or a zero-length List
if there are no registered Rule instances. If more than one Rule
instance has been registered, they must be returned
in the order originally registered through the add()
method.
|
| 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 |
|
|