1 package org.apache.commons.digester3.binder; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 /** 23 * A support class for RulesModule which reduces repetition and results in a more readable configuration, that 24 * sets rules binding for a defined namespace URI (it can be overridden while binding). 25 * 26 * @since 3.0 27 */ 28 public abstract class AbstractNamespaceURIBasedRulesModule 29 extends AbstractRulesModule 30 { 31 32 private final String namespaceURI; 33 34 /** 35 * Creates a new (nullable) namespaceURI-based {@link RulesModule} that automatically binds every 36 * rule to the input namespaceURI. 37 * 38 * @param namespaceURI Namespace URI for which this Rule is relevant, or <code>null</code> to match 39 * independent of namespace. 40 */ 41 public AbstractNamespaceURIBasedRulesModule( /* @Nullable */String namespaceURI ) 42 { 43 this.namespaceURI = namespaceURI; 44 } 45 46 /** 47 * {@inheritDoc} 48 */ 49 @Override 50 protected LinkedRuleBuilder forPattern( String pattern ) 51 { 52 return super.forPattern( pattern ).withNamespaceURI( namespaceURI ); 53 } 54 55 }