01: /* $Id: RuleSetBase.java 471661 2006-11-06 08:09:25Z skitching $
02: *
03: * Licensed to the Apache Software Foundation (ASF) under one or more
04: * contributor license agreements. See the NOTICE file distributed with
05: * this work for additional information regarding copyright ownership.
06: * The ASF licenses this file to You under the Apache License, Version 2.0
07: * (the "License"); you may not use this file except in compliance with
08: * the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing, software
13: * distributed under the License is distributed on an "AS IS" BASIS,
14: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: * See the License for the specific language governing permissions and
16: * limitations under the License.
17: */
18:
19: package org.apache.commons.digester;
20:
21: /**
22: * <p>Convenience base class that implements the {@link RuleSet} interface.
23: * Concrete implementations should list all of their actual rule creation
24: * logic in the <code>addRuleSet()</code> implementation.</p>
25: */
26:
27: public abstract class RuleSetBase implements RuleSet {
28:
29: // ----------------------------------------------------- Instance Variables
30:
31: /**
32: * The namespace URI that all Rule instances created by this RuleSet
33: * will be associated with.
34: */
35: protected String namespaceURI = null;
36:
37: // ------------------------------------------------------------- Properties
38:
39: /**
40: * Return the namespace URI that will be applied to all Rule instances
41: * created from this RuleSet.
42: */
43: public String getNamespaceURI() {
44:
45: return (this .namespaceURI);
46:
47: }
48:
49: // --------------------------------------------------------- Public Methods
50:
51: /**
52: * Add the set of Rule instances defined in this RuleSet to the
53: * specified <code>Digester</code> instance, associating them with
54: * our namespace URI (if any). This method should only be called
55: * by a Digester instance.
56: *
57: * @param digester Digester instance to which the new Rule instances
58: * should be added.
59: */
60: public abstract void addRuleInstances(Digester digester);
61:
62: }
|