001package org.apache.commons.digester3.plugins;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Defines an interface that a Rule class can implement if it wishes to get an initialisation callback after the rule
024 * has been added to the set of Rules within a PluginRules instance.
025 * 
026 * @since 1.6
027 */
028public interface InitializableRule
029{
030
031    /**
032     * Called after this Rule object has been added to the list of all Rules. Note that if a single InitializableRule
033     * instance is associated with 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 rule.
036     */
037    void postRegisterInit( String pattern );
038
039}