| org.apache.tomcat.util.digester.Rules
All known Subclasses: org.apache.tomcat.util.digester.AbstractRulesImpl, org.apache.tomcat.util.digester.RulesBase, org.apache.tomcat.util.digester.WithDefaultsRulesWrapper,
| Rules | | public interface Rules (Code) | | 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.
|
| Method Summary | |
| public void | add(String pattern, Rule rule)
Register a new Rule instance matching the specified pattern. | | 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. | | 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. | | 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) | | Register a new Rule instance matching the specified pattern.
Parameters:
pattern - Nesting pattern to be matched for this Rule
Parameters:
rule - Rule instance to be registered |
| clear | | 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 | | 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 |
| rules | | 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 |
|
|