001/* $Id: InitializableRule.java 992060 2010-09-02 19:09:47Z simonetripodi $
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 */
018package org.apache.commons.digester.plugins;
019
020/**
021 * Defines an interface that a Rule class can implement if it wishes to get an
022 * initialisation callback after the rule has been added to the set of Rules
023 * within a PluginRules instance.
024 *
025 * @since 1.6
026 */
027
028public interface InitializableRule {
029
030    /**
031     * Called after this Rule object has been added to the list of all Rules.
032     * Note that if a single InitializableRule instance is associated with
033     * more than one pattern, then this method will be called more than once.
034     * 
035     * @param pattern is the digester match pattern that will trigger this
036     *        rule.
037     * @exception
038     *  PluginConfigurationException is thrown if the InitializableRule 
039     *  determines that it cannot correctly initialise itself for any reason.
040     */
041    public void postRegisterInit(String pattern)
042                                 throws PluginConfigurationException;
043}