01: /* $Id: InitializableRule.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: /**
22: * Defines an interface that a Rule class can implement if it wishes to get an
23: * initialisation callback after the rule has been added to the set of Rules
24: * within a PluginRules instance.
25: *
26: * @since 1.6
27: */
28:
29: public interface InitializableRule {
30:
31: /**
32: * Called after this Rule object has been added to the list of all Rules.
33: * Note that if a single InitializableRule instance is associated with
34: * more than one pattern, then this method will be called more than once.
35: *
36: * @param pattern is the digester match pattern that will trigger this
37: * rule.
38: * @exception
39: * PluginConfigurationException is thrown if the InitializableRule
40: * determines that it cannot correctly initialise itself for any reason.
41: */
42: public void postRegisterInit(String pattern)
43: throws PluginConfigurationException;
44: }
|