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 import org.apache.commons.digester3.Digester; 23 24 /** 25 * Interface for classes which can dynamically load custom plugin rules associated with a user's plugin class. 26 * <p> 27 * Each plugin declaration has an associated RuleLoader instance, and that instance's addRules method is invoked each 28 * time the input xml specifies that an instance of that plugged-in class is to be created. 29 * <p> 30 * This is an abstract class rather than an interface in order to make it possible to enhance this class in future 31 * without breaking binary compatibility; it is possible to add methods to an abstract class, but not to an interface. 32 * 33 * @since 1.6 34 */ 35 public abstract class RuleLoader 36 { 37 38 /** 39 * Configures the digester with custom rules for some plugged-in class. 40 * <p> 41 * This method is invoked when the start of an xml tag is encountered which maps to a PluginCreateRule. Any rules 42 * added here are removed from the digester when the end of that xml tag is encountered. 43 * 44 * @param d The gigester has to be configured 45 * @param path The path where rule has to be bound 46 * @throws PluginException if any error occurs 47 */ 48 public abstract void addRules( Digester d, String path ) 49 throws PluginException; 50 51 }