core/src/main/java/org/apache/commons/digester3/binder/AbstractNamespaceURIBasedRulesModule.java

package org.apache.commons.digester3.binder;

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

/**
 * A support class for RulesModule which reduces repetition and results in a more readable configuration, that
 * sets rules binding for a defined namespace URI (it can be overridden while binding).
 *
 * @since 3.0
 */
public abstract class AbstractNamespaceURIBasedRulesModule
    extends AbstractRulesModule
{

    private final String namespaceURI;

    /**
     * Creates a new (nullable) namespaceURI-based {@link RulesModule} that automatically binds every
     * rule to the input namespaceURI.
     *
     * @param namespaceURI Namespace URI for which this Rule is relevant, or <code>null</code> to match
     *        independent of namespace.
     */
    public AbstractNamespaceURIBasedRulesModule( /* @Nullable */String namespaceURI )
    {
        this.namespaceURI = namespaceURI;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected LinkedRuleBuilder forPattern( String pattern )
    {
        return super.forPattern( pattern ).withNamespaceURI( namespaceURI );
    }

}