001    /* $Id: InitializableRule.java 471661 2006-11-06 08:09:25Z skitching $
002     *
003     * Licensed to the Apache Software Foundation (ASF) under one or more
004     * contributor license agreements.  See the NOTICE file distributed with
005     * this work for additional information regarding copyright ownership.
006     * The ASF licenses this file to You under the Apache License, Version 2.0
007     * (the "License"); you may not use this file except in compliance with
008     * the License.  You may obtain a copy of the License at
009     * 
010     *      http://www.apache.org/licenses/LICENSE-2.0
011     * 
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */ 
018     
019    package org.apache.commons.digester.plugins;
020    
021    /**
022     * Defines an interface that a Rule class can implement if it wishes to get an
023     * initialisation callback after the rule has been added to the set of Rules
024     * within a PluginRules instance.
025     *
026     * @since 1.6
027     */
028    
029    public interface InitializableRule {
030    
031        /**
032         * Called after this Rule object has been added to the list of all Rules.
033         * Note that if a single InitializableRule instance is associated with
034         * more than one pattern, then this method will be called more than once.
035         * 
036         * @param pattern is the digester match pattern that will trigger this
037         *        rule.
038         * @exception
039         *  PluginConfigurationException is thrown if the InitializableRule 
040         *  determines that it cannot correctly initialise itself for any reason.
041         */
042        public void postRegisterInit(String pattern)
043                                     throws PluginConfigurationException;
044    }