01: /* $Id: RulesFactory.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.plugins;
20:
21: import org.apache.commons.digester.Digester;
22: import org.apache.commons.digester.Rules;
23:
24: /**
25: * Whenever the scope of a plugin tag is entered, the PluginRules class
26: * creates a new Rules instance and configures it with the appropriate
27: * parsing rules for the plugged-in class.
28: * <p>
29: * Users of the plugins module can specify a subclass of this one to
30: * control the creation of that Rules object. In particular, it can
31: * set up default rules within the returned instance which are applicable
32: * to all plugged-in classes.
33: *
34: * @since 1.6
35: */
36:
37: public abstract class RulesFactory {
38:
39: /**
40: * Return an instance of some Rules implementation that the plugged-in
41: * class shall use to match its private parsing rules.
42: * <p>
43: * @param d is the digester that the returned rules object will be
44: * associated with.
45: *
46: * @param pluginClass is the class that is to be configured using rules
47: * added to the returnedobject.
48: *
49: * @throws PluginException if the algorithm finds a source
50: * of rules, but there is something invalid about that source.
51: */
52:
53: public abstract Rules newRules(Digester d, Class pluginClass)
54: throws PluginException;
55: }
|