/* $Id: Rules.java 992060 2010-09-02 19:09:47Z simonetripodi $
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package org.apache.commons.digester;


import java.util.List;


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.
/**
 * 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.
 */

public interface Rules {


    // ------------------------------------------------------------- Properties


    
Return the Digester instance with which this Rules instance is
associated.
/**
     * Return the Digester instance with which this Rules instance is
     * associated.
     */
    public Digester getDigester();


    
Set the Digester instance with which this Rules instance is associated.
Params:
digester – The newly associated Digester instance/**
     * Set the Digester instance with which this Rules instance is associated.
     *
     * @param digester The newly associated Digester instance
     */
    public void setDigester(Digester digester);


    
Return the namespace URI that will be applied to all subsequently
added Rule objects.
/**
     * Return the namespace URI that will be applied to all subsequently
     * added <code>Rule</code> objects.
     */
    public String getNamespaceURI();


    
Set the namespace URI that will be applied to all subsequently
added Rule objects.
Params:
namespaceURI – Namespace URI that must match on all
 subsequently added rules, or null for matching
 regardless of the current namespace URI/**
     * Set the namespace URI that will be applied to all subsequently
     * added <code>Rule</code> objects.
     *
     * @param namespaceURI Namespace URI that must match on all
     *  subsequently added rules, or <code>null</code> for matching
     *  regardless of the current namespace URI
     */
    public void setNamespaceURI(String namespaceURI);


    // --------------------------------------------------------- Public Methods


    
Register a new Rule instance matching the specified pattern.
Params:
pattern – Nesting pattern to be matched for this Rule
rule – Rule instance to be registered/**
     * Register a new Rule instance matching the specified pattern.
     *
     * @param pattern Nesting pattern to be matched for this Rule
     * @param rule Rule instance to be registered
     */
    public void add(String pattern, Rule rule);


    
Clear all existing Rule instance registrations.
/**
     * Clear all existing Rule instance registrations.
     */
    public void clear();


    
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.
Params:
pattern – Nesting pattern to be matched
Deprecated:
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 <strong>must</strong> be returned
     * in the order originally registered through the <code>add()</code>
     * method.
     *
     * @param pattern Nesting pattern to be matched
     *
     * @deprecated Call match(namespaceURI,pattern) instead.
     */
    @Deprecated
    public List<Rule> 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.  If more
than one Rule instance matches, they must be returned
in the order originally registered through the add()
method.
Params:
namespaceURI – Namespace URI for which to select matching rules,
 or null to match regardless of namespace URI
pattern – Nesting pattern to be matched/**
     * 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 <strong>must</strong> be returned
     * in the order originally registered through the <code>add()</code>
     * method.
     *
     * @param namespaceURI Namespace URI for which to select matching rules,
     *  or <code>null</code> to match regardless of namespace URI
     * @param pattern Nesting pattern to be matched
     */
    public List<Rule> match(String namespaceURI, String pattern);


    
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.
/**
     * 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 <strong>must</strong> be returned
     * in the order originally registered through the <code>add()</code>
     * method.
     */
    public List<Rule> rules();


}