package org.apache.commons.digester3;

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

import java.util.List;

/**
 * <p>
 * <code>AbstractRuleImpl</code> provides basic services for <code>Rules</code> implementations. Extending this class
 * should make it easier to create a <code>Rules</code> implementation.
 * </p>
 * <p>
 * <code>AbstractRuleImpl</code> manages the <code>Digester</code> and <code>namespaceUri</code> properties. If the
 * subclass overrides {@link #registerRule} (rather than {@link #add}), then the <code>Digester</code> and
 * <code>namespaceURI</code> of the <code>Rule</code> will be set correctly before it is passed to
 * <code>registerRule</code>. The subclass can then perform whatever it needs to do to register the rule.
 * </p>
 * 
 * @since 1.5
 */
public abstract class AbstractRulesImpl
    implements Rules
{

    // ------------------------------------------------------------- Fields

    /** Digester using this <code>Rules</code> implementation */
    private Digester digester;

    /** Namespace uri to assoicate with subsequent <code>Rule</code>'s */
    private String namespaceURI;

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

    /**
     * {@inheritDoc}
     */
    public Digester getDigester()
    {
        return digester;
    }

    /**
     * {@inheritDoc}
     */
    public void setDigester( Digester digester )
    {
        this.digester = digester;
    }

    /**
     * {@inheritDoc}
     */
    public String getNamespaceURI()
    {
        return namespaceURI;
    }

    /**
     * {@inheritDoc}
     */
    public void setNamespaceURI( String namespaceURI )
    {
        this.namespaceURI = namespaceURI;
    }

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

    /**
     * Registers a new Rule instance matching the specified pattern. This implementation sets the <code>Digester</code>
     * and the <code>namespaceURI</code> on the <code>Rule</code> before calling {@link #registerRule}.
     * 
     * @param pattern Nesting pattern to be matched for this Rule
     * @param rule Rule instance to be registered
     */
    public void add( String pattern, Rule rule )
    {
        // set up rule
        if ( this.digester != null )
        {
            rule.setDigester( this.digester );
        }

        if ( this.namespaceURI != null )
        {
            rule.setNamespaceURI( this.namespaceURI );
        }

        registerRule( pattern, rule );
    }

    /**
     * Register rule at given pattern. The the Digester and namespaceURI properties of the given <code>Rule</code> can
     * be assumed to have been set properly before this method is called.
     * 
     * @param pattern Nesting pattern to be matched for this Rule
     * @param rule Rule instance to be registered
     */
    protected abstract void registerRule( String pattern, Rule rule );

    /**
     * Clear all existing Rule instance registrations.
     */
    public abstract 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 <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
     * @return A List of all registered Rule instances that match the specified nesting pattern
     */
    public abstract 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 <strong>must</strong> be returned in the order
     * originally registered through the <code>add()</code> method.
     *
     * @return A List of all registered Rule instances
     */
    public abstract List<Rule> rules();

}

@@ -845,31 +845,8 @@
 */%0A%0A
-import java.util.List;%0A
 %0A/**
@@ -3647,1243 +3647,6 @@
 );%0A%0A
-    /**%0A     * Clear all existing Rule instance registrations.%0A     */%0A    public abstract void clear();%0A%0A    /**%0A     * Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if%0A     * there are no matches. If more than one Rule instance matches, they %3Cstrong%3Emust%3C/strong%3E be returned in the order%0A     * originally registered through the %3Ccode%3Eadd()%3C/code%3E method.%0A     * %0A     * @param namespaceURI Namespace URI for which to select matching rules, or %3Ccode%3Enull%3C/code%3E to match regardless of%0A     *            namespace URI%0A     * @param pattern Nesting pattern to be matched%0A     * @return A List of all registered Rule instances that match the specified nesting pattern%0A     */%0A    public abstract List%3CRule%3E match( String namespaceURI, String pattern );%0A%0A    /**%0A     * Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.%0A     * If more than one Rule instance has been registered, they %3Cstrong%3Emust%3C/strong%3E be returned in the order%0A     * originally registered through the %3Ccode%3Eadd()%3C/code%3E method.%0A     *%0A     * @return A List of all registered Rule instances%0A     */%0A    public abstract List%3CRule%3E rules();%0A%0A
 %7D%0A

removed redundant abstract methods