View Javadoc

1   package org.apache.commons.digester3.plugins;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * Defines an interface that a Rule class can implement if it wishes to get an initialisation callback after the rule
24   * has been added to the set of Rules within a PluginRules instance.
25   * 
26   * @since 1.6
27   */
28  public interface InitializableRule
29  {
30  
31      /**
32       * Called after this Rule object has been added to the list of all Rules. Note that if a single InitializableRule
33       * instance is associated with 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 rule.
36       */
37      void postRegisterInit( String pattern );
38  
39  }