Rules (Apache Commons Digester 3.3-SNAPSHOT API)

All Known Implementing Classes:

AbstractRulesImpl, ExtendedBaseRules, PluginRules, RegexRules, RulesBase, WithDefaultsRulesWrapper
```
public interface Rules
```
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

Methods
Modifier and Type	Method and Description
`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<Rule>`	`match(String namespaceURI, String pattern, String name, Attributes attributes)` 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<Rule>`	`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.

- Method Detail
  - getDigester
```
Digester getDigester()
```
    Return the Digester instance with which this Rules instance is associated.
    
    Returns:
    the Digester instance with which this Rules instance is associated
  - setDigester
```
void setDigester(Digester digester)
```
    Set the Digester instance with which this Rules instance is associated.
    
    Parameters:
    digester - The newly associated Digester instance
  - getNamespaceURI
```
String getNamespaceURI()
```
    Return the namespace URI that will be applied to all subsequently added Rule objects.
    
    Returns:
    the namespace URI that will be applied to all subsequently added Rule objects.
  - setNamespaceURI
```
void setNamespaceURI(String namespaceURI)
```
    Set the namespace URI that will be applied to all subsequently added Rule objects.
    
    Parameters:
    namespaceURI - Namespace URI that must match on all subsequently added rules, or null for matching regardless of the current namespace URI
  - add
```
void add(String pattern,
       Rule rule)
```
    Register a new Rule instance matching the specified pattern.
    
    Parameters:
    pattern - Nesting pattern to be matched for this Rule
    rule - Rule instance to be registered
  - clear
```
void clear()
```
    Clear all existing Rule instance registrations.
  - match
```
List<Rule> match(String namespaceURI,
               String pattern,
               String name,
               Attributes attributes)
```
    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
    pattern - Nesting pattern to be matched
    name - the local name if the parser is namespace aware, or just the element name otherwise
    attributes - The attribute list of the current matching element
    
    Returns:
    a List of all registered Rule instances that match the specified nesting pattern
  - rules
```
List<Rule> 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.
    
    Returns:
    a List of all registered Rule instances

Interface Rules

Method Summary

Method Detail

getDigester

setDigester

getNamespaceURI

setNamespaceURI

add

clear

match

rules