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
022import org.apache.commons.digester3.Digester;
023import org.apache.commons.digester3.Rules;
024
025/**
026 * Whenever the scope of a plugin tag is entered, the PluginRules class creates a new Rules instance and configures it
027 * with the appropriate parsing rules for the plugged-in class.
028 * <p>
029 * Users of the plugins module can specify a subclass of this one to control the creation of that Rules object. In
030 * particular, it can set up default rules within the returned instance which are applicable to all plugged-in classes.
031 * 
032 * @since 1.6
033 */
034public abstract class RulesFactory
035{
036
037    /**
038     * Return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing
039     * rules.
040     * <p>
041     * 
042     * @param d is the digester that the returned rules object will be associated with.
043     * @param pluginClass is the class that is to be configured using rules added to the returned object.
044     * @return an instance of some Rules implementation that the plugged-in class shall use to match its private parsing
045     *         rules.
046     * @throws PluginException if the algorithm finds a source of rules, but there is something invalid about that
047     *             source.
048     */
049    public abstract Rules newRules( Digester d, Class<?> pluginClass )
050        throws PluginException;
051
052}