/* * 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 acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xalan" 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 name, without prior written * permission of the Apache Software Foundation. * * 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 and was * originally based on software copyright (c) 1999, Lotus * Development Corporation., http://www.lotus.com. For more * information on the Apache Software Foundation, please see * . */ package org.apache.xml.serializer; import org.xml.sax.Attributes; /** * This interface defines a set of integer constants that identify trace event * types. */ public interface SerializerTrace { /** * Event type generated when a document begins. * */ public static final int EVENTTYPE_STARTDOCUMENT = 1; /** * Event type generated when a document ends. */ public static final int EVENTTYPE_ENDDOCUMENT = 2; /** * Event type generated when an element begins (after the attributes have been processed but before the children have been added). */ public static final int EVENTTYPE_STARTELEMENT = 3; /** * Event type generated when an element ends, after it's children have been added. */ public static final int EVENTTYPE_ENDELEMENT = 4; /** * Event type generated for character data (CDATA and Ignorable Whitespace have their own events). */ public static final int EVENTTYPE_CHARACTERS = 5; /** * Event type generated for ignorable whitespace (I'm not sure how much this is actually called. */ public static final int EVENTTYPE_IGNORABLEWHITESPACE = 6; /** * Event type generated for processing instructions. */ public static final int EVENTTYPE_PI = 7; /** * Event type generated after a comment has been added. */ public static final int EVENTTYPE_COMMENT = 8; /** * Event type generate after an entity ref is created. */ public static final int EVENTTYPE_ENTITYREF = 9; /** * Event type generated after CDATA is generated. */ public static final int EVENTTYPE_CDATA = 10; /** * Event type generated when characters might be written to an output stream, * but these characters never are. They will ultimately be written out via * EVENTTYPE_OUTPUT_CHARACTERS. This type is used as attributes are collected. * Whenever the attributes change this event type is fired. At the very end * however, when the attributes do not change anymore and are going to be * ouput to the document the real characters will be written out using the * EVENTTYPE_OUTPUT_CHARACTERS. */ public static final int EVENTTYPE_OUTPUT_PSEUDO_CHARACTERS = 11; /** * Event type generated when characters are written to an output stream. */ public static final int EVENTTYPE_OUTPUT_CHARACTERS = 12; /** * Tell if trace listeners are present. * * @return True if there are trace listeners */ public boolean hasTraceListeners(); /** * Fire startDocument, endDocument events. * * @param eventType One of the EVENTTYPE_XXX constants. */ public void fireGenerateEvent(int eventType); /** * Fire startElement, endElement events. * * @param eventType One of the EVENTTYPE_XXX constants. * @param name The name of the element. * @param atts The SAX attribute list. */ public void fireGenerateEvent(int eventType, String name, Attributes atts); /** * Fire characters, cdata events. * * @param eventType One of the EVENTTYPE_XXX constants. * @param ch The char array from the SAX event. * @param start The start offset to be used in the char array. * @param length The end offset to be used in the chara array. */ public void fireGenerateEvent(int eventType, char ch[], int start, int length); /** * Fire processingInstruction events. * * @param eventType One of the EVENTTYPE_XXX constants. * @param name The name of the processing instruction. * @param data The processing instruction data. */ public void fireGenerateEvent(int eventType, String name, String data); /** * Fire comment and entity ref events. * * @param eventType One of the EVENTTYPE_XXX constants. * @param data The comment or entity ref data. */ public void fireGenerateEvent(int eventType, String data); }