/* * $Header: /home/cvspublic/jakarta-commons/digester/src/java/org/apache/commons/digester/Rule.java,v 1.9 2003/02/02 16:09:53 rdonkin Exp $ * $Revision: 1.9 $ * $Date: 2003/02/02 16:09:53 $ * * ==================================================================== * * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2003 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 * . * */ package org.apache.commons.digester; import org.xml.sax.Attributes; /** * Concrete implementations of this class implement actions to be taken when * a corresponding nested pattern of XML elements has been matched. * * @author Craig McClanahan * @author Christopher Lenz * @version $Revision: 1.9 $ $Date: 2003/02/02 16:09:53 $ */ public abstract class Rule { // ----------------------------------------------------------- Constructors /** * Constructor sets the associated Digester. * * @param digester The digester with which this rule is associated * @deprecated The digester instance is now set in the {@link Digester#addRule} method. Use {@link #Rule()} instead. */ public Rule(Digester digester) { super(); setDigester(digester); } /** *

Base constructor. * Now the digester will be set when the rule is added.

*/ public Rule() {} // ----------------------------------------------------- Instance Variables /** * The Digester with which this Rule is associated. */ protected Digester digester = null; /** * The namespace URI for which this Rule is relevant, if any. */ protected String namespaceURI = null; // ------------------------------------------------------------- Properties /** * Return the Digester with which this Rule is associated. */ public Digester getDigester() { return (this.digester); } /** * Set the Digester with which this Rule is associated. */ public void setDigester(Digester digester) { this.digester = digester; } /** * Return the namespace URI for which this Rule is relevant, if any. */ public String getNamespaceURI() { return (this.namespaceURI); } /** * Set the namespace URI for which this Rule is relevant, if any. * * @param namespaceURI Namespace URI for which this Rule is relevant, * or null to match independent of namespace. */ public void setNamespaceURI(String namespaceURI) { this.namespaceURI = namespaceURI; } // --------------------------------------------------------- Public Methods /** * This method is called when the beginning of a matching XML element * is encountered. * * @param attributes The attribute list of this element * @deprecated Use the {@link #begin(String,String,Attributes) begin} * method with namespace and name * parameters instead. */ public void begin(Attributes attributes) throws Exception { ; // The default implementation does nothing } /** * This method is called when the beginning of a matching XML element * is encountered. The default implementation delegates to the deprecated * method {@link #begin(Attributes) begin} without the * namespace and name parameters, to retain * backwards compatibility. * * @param namespace the namespace URI of the matching element, or an * empty string if the parser is not namespace aware or the element has * no namespace * @param name the local name if the parser is namespace aware, or just * the element name otherwise * @param attributes The attribute list of this element * @since Digester 1.4 */ public void begin(String namespace, String name, Attributes attributes) throws Exception { begin(attributes); } /** * This method is called when the body of a matching XML element * is encountered. If the element has no body, this method is * not called at all. * * @param text The text of the body of this element * @deprecated Use the {@link #body(String,String,String) body} method * with namespace and name parameters * instead. */ public void body(String text) throws Exception { ; // The default implementation does nothing } /** * This method is called when the body of a matching XML element is * encountered. If the element has no body, this method is not called at * all. The default implementation delegates to the deprecated method * {@link #body(String) body} without the namespace and * name parameters, to retain backwards compatibility. * * @param namespace the namespace URI of the matching element, or an * empty string if the parser is not namespace aware or the element has * no namespace * @param name the local name if the parser is namespace aware, or just * the element name otherwise * @param text The text of the body of this element * @since Digester 1.4 */ public void body(String namespace, String name, String text) throws Exception { body(text); } /** * This method is called when the end of a matching XML element * is encountered. * * @deprecated Use the {@link #end(String,String) end} method with * namespace and name parameters instead. */ public void end() throws Exception { ; // The default implementation does nothing } /** * This method is called when the end of a matching XML element * is encountered. The default implementation delegates to the deprecated * method {@link #end end} without the * namespace and name parameters, to retain * backwards compatibility. * * @param namespace the namespace URI of the matching element, or an * empty string if the parser is not namespace aware or the element has * no namespace * @param name the local name if the parser is namespace aware, or just * the element name otherwise * @since Digester 1.4 */ public void end(String namespace, String name) throws Exception { end(); } /** * This method is called after all parsing methods have been * called, to allow Rules to remove temporary data. */ public void finish() throws Exception { ; // The default implementation does nothing } }