001    package org.apache.commons.digester3.binder;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    /**
023     * A support class for RulesModule which reduces repetition and results in a more readable configuration, that
024     * sets rules binding for a defined namespace URI (it can be overridden while binding).
025     *
026     * @since 3.0
027     */
028    public abstract class AbstractNamespaceURIBasedRulesModule
029        extends AbstractRulesModule
030    {
031    
032        private final String namespaceURI;
033    
034        /**
035         * Creates a new (nullable) namespaceURI-based {@link RulesModule} that automatically binds every
036         * rule to the input namespaceURI.
037         *
038         * @param namespaceURI Namespace URI for which this Rule is relevant, or <code>null</code> to match
039         *        independent of namespace.
040         */
041        public AbstractNamespaceURIBasedRulesModule( /* @Nullable */String namespaceURI )
042        {
043            this.namespaceURI = namespaceURI;
044        }
045    
046        /**
047         * {@inheritDoc}
048         */
049        @Override
050        protected LinkedRuleBuilder forPattern( String pattern )
051        {
052            return super.forPattern( pattern ).withNamespaceURI( namespaceURI );
053        }
054    
055    }