1. /* $Id: InitializableRule.java,v 1.11 2004/05/10 06:44:13 skitching Exp $

  2.  *

  3.  * Copyright 2003-2004 The Apache Software Foundation.

  4.  * 

  5.  * Licensed under the Apache License, Version 2.0 (the "License");

  6.  * you may not use this file except in compliance with the License.

  7.  * You may obtain a copy of the License at

  8.  * 

  9.  *      http://www.apache.org/licenses/LICENSE-2.0

  10.  * 

  11.  * Unless required by applicable law or agreed to in writing, software

  12.  * distributed under the License is distributed on an "AS IS" BASIS,

  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  14.  * See the License for the specific language governing permissions and

  15.  * limitations under the License.

  16.  */ 

  17.  

  18. package org.apache.commons.digester.plugins;

  19. 

  20. /**

  21.  * Defines an interface that a Rule class can implement if it wishes to get an

  22.  * initialisation callback after the rule has been added to the set of Rules

  23.  * within a PluginRules instance.

  24.  *

  25.  * @since 1.6

  26.  */

  27. 

  28. public interface InitializableRule {

  29. 

  30.     /**

  31.      * Called after this Rule object has been added to the list of all Rules.

  32.      * Note that if a single InitializableRule instance is associated with

  33.      * more than one pattern, then this method will be called more than once.

  34.      * 

  35.      * @param pattern is the digester match pattern that will trigger this

  36.      *        rule.

  37.      * @exception

  38.      *  PluginConfigurationException is thrown if the InitializableRule 

  39.      *  determines that it cannot correctly initialise itself for any reason.

  40.      */

  41.     public void postRegisterInit(String pattern)

  42.                                  throws PluginConfigurationException;

  43. }