| /* |
| * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//digester/src/java/org/apache/commons/digester/RuleSet.java,v 1.2 2002/01/09 20:22:49 sanders Exp $ |
| * $Revision: 1.2 $ |
| * $Date: 2002/01/09 20:22:49 $ |
| * |
| * ==================================================================== |
| * |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 1999-2002 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, if |
| * any, must include the following acknowlegement: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowlegement may appear in the software itself, |
| * if and wherever such third-party acknowlegements normally appear. |
| * |
| * 4. The names "The Jakarta Project", "Commons", and "Apache Software |
| * Foundation" must not be used to endorse or promote products derived |
| * from this software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache" |
| * nor may "Apache" appear in their names without prior written |
| * permission of the Apache Group. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| * |
| */ |
| |
| |
| package org.apache.commons.digester; |
| |
| |
| /** |
| * <p>Public interface defining a shorthand means of configuring a complete |
| * set of related <code>Rule</code> definitions, possibly associated with |
| * a particular namespace URI, in one operation. To use an instance of a |
| * class that imlements this interface:</p> |
| * <ul> |
| * <li>Create a concrete implementation of this interface.</li> |
| * <li>Optionally, you can configure a <code>RuleSet</code> to be relevant |
| * only for a particular namespace URI by configuring the value to be |
| * returned by <code>getNamespaceURI()</code>.</li> |
| * <li>As you are configuring your Digester instance, call |
| * <code>digester.addRuleSet()</code> and pass the RuleSet instance.</li> |
| * <li>Digester will call the <code>addRuleInstances()</code> method of |
| * your RuleSet to configure the necessary rules.</li> |
| * </ul> |
| * |
| * @author Craig R. McClanahan |
| * @version $Revision: 1.2 $ $Date: 2002/01/09 20:22:49 $ |
| */ |
| |
| public interface RuleSet { |
| |
| |
| // ------------------------------------------------------------- Properties |
| |
| |
| /** |
| * Return the namespace URI that will be applied to all Rule instances |
| * created from this RuleSet. |
| */ |
| public String getNamespaceURI(); |
| |
| |
| // --------------------------------------------------------- Public Methods |
| |
| |
| /** |
| * Add the set of Rule instances defined in this RuleSet to the |
| * specified <code>Digester</code> instance, associating them with |
| * our namespace URI (if any). This method should only be called |
| * by a Digester instance. |
| * |
| * @param digester Digester instance to which the new Rule instances |
| * should be added. |
| */ |
| public void addRuleInstances(Digester digester); |
| |
| |
| } |