org.apache.commons.digester
Interface Rules
- AbstractRulesImpl, DigesterRuleParser.RulesPrefixAdapter, ExtendedBaseRules, PluginRules, RegexRules, RulesBase, SetNestedPropertiesRule.AnyChildRules, WithDefaultsRulesWrapper
Public interface defining a collection of Rule instances (and corresponding
matching patterns) plus an implementation of a matching policy that selects
the rules that match a particular pattern of nested elements discovered
during parsing.
void | add(String pattern, Rule rule) - Register a new Rule instance matching the specified pattern.
|
void | clear() - Clear all existing Rule instance registrations.
|
Digester | getDigester() - Return the Digester instance with which this Rules instance is
associated.
|
String | getNamespaceURI() - Return the namespace URI that will be applied to all subsequently
added
Rule objects.
|
List | match(String pattern) - Call match(namespaceURI,pattern) instead.
|
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.
|
List | rules() - Return a List of all registered Rule instances, or a zero-length List
if there are no registered Rule instances.
|
void | setDigester(Digester digester) - Set the Digester instance with which this Rules instance is associated.
|
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)
Register a new Rule instance matching the specified pattern.
pattern
- Nesting pattern to be matched for this Rulerule
- Rule instance to be registered
clear
public void clear()
Clear all existing Rule instance registrations.
getDigester
public Digester getDigester()
Return the Digester instance with which this Rules instance is
associated.
getNamespaceURI
public String getNamespaceURI()
Return the namespace URI that will be applied to all subsequently
added Rule
objects.
match
public List match(String pattern)
Call match(namespaceURI,pattern) instead.
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.
pattern
- Nesting pattern to be matched
match
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. If more
than one Rule instance matches, they must be returned
in the order originally registered through the add()
method.
namespaceURI
- Namespace URI for which to select matching rules,
or null
to match regardless of namespace URIpattern
- Nesting pattern to be matched
rules
public List rules()
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)
Set the Digester instance with which this Rules instance is associated.
digester
- The newly associated Digester instance
setNamespaceURI
public void setNamespaceURI(String namespaceURI)
Set the namespace URI that will be applied to all subsequently
added Rule
objects.
namespaceURI
- Namespace URI that must match on all
subsequently added rules, or null
for matching
regardless of the current namespace URI
Copyright 2001-2005 The Apache Software Foundation.