325N/A/*
325N/A * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.xml.internal.txw2.output;
325N/A
325N/Aimport com.sun.xml.internal.txw2.TypedXmlWriter;
325N/A
325N/A
325N/A/**
325N/A * Low-level typeless XML writer driven from {@link TypedXmlWriter}.
325N/A *
325N/A * <p>
325N/A * Applications can use one of the predefined implementations to
325N/A * send TXW output to the desired location/format, or they can
325N/A * choose to implement this interface for custom output.
325N/A *
325N/A * <p>
325N/A * One {@link XmlSerializer} instance is responsible for writing
325N/A * one XML document.
325N/A *
325N/A * <h2>Call Sequence</h2>
325N/A * TXW calls methods on this interface in the following order:
325N/A *
325N/A * <pre>
325N/A * WHOLE_SEQUENCE := startDocument ELEMENT endDocument
325N/A * ELEMENT := beginStartTag writeXmlns* writeAttribute* endStartTag CONTENT endTag
325N/A * CONTENT := (text|ELEMENT)*
325N/A * </pre>
325N/A *
325N/A * <p>
325N/A * TXW maintains all the in-scope namespace bindings and prefix allocation.
325N/A * The {@link XmlSerializer} implementation should just use the prefix
325N/A * specified.
325N/A * </p>
325N/A *
325N/A * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
325N/A */
325N/Apublic interface XmlSerializer {
325N/A /**
325N/A * The first method to be called.
325N/A */
325N/A void startDocument();
325N/A
325N/A /**
325N/A * Begins writing a start tag.
325N/A *
325N/A * @param uri
325N/A * the namespace URI of the element. Can be empty but never be null.
325N/A * @param prefix
325N/A * the prefix that should be used for this element. Can be empty,
325N/A * but never null.
325N/A */
325N/A void beginStartTag(String uri,String localName,String prefix);
325N/A
325N/A /**
325N/A * Writes an attribute.
325N/A *
325N/A * @param value
325N/A * The value of the attribute. It's the callee's responsibility to
325N/A * escape special characters (such as &lt;, &gt;, and &amp;) in this buffer.
325N/A *
325N/A * @param uri
325N/A * the namespace URI of the attribute. Can be empty but never be null.
325N/A * @param prefix
325N/A * the prefix that should be used for this attribute. Can be empty,
325N/A * but never null.
325N/A */
325N/A void writeAttribute(String uri,String localName,String prefix,StringBuilder value);
325N/A
325N/A /**
325N/A * Writes a namespace declaration.
325N/A *
325N/A * @param uri
325N/A * the namespace URI to be declared. Can be empty but never be null.
325N/A * @param prefix
325N/A * the prefix that is allocated. Can be empty but never be null.
325N/A */
325N/A void writeXmlns(String prefix,String uri);
325N/A
325N/A /**
325N/A * Completes the start tag.
325N/A *
325N/A * @param uri
325N/A * the namespace URI of the element. Can be empty but never be null.
325N/A * @param prefix
325N/A * the prefix that should be used for this element. Can be empty,
325N/A * but never null.
325N/A */
325N/A void endStartTag(String uri,String localName,String prefix);
325N/A
325N/A /**
325N/A * Writes an end tag.
325N/A */
325N/A void endTag();
325N/A
325N/A /**
325N/A * Writes PCDATA.
325N/A *
325N/A * @param text
325N/A * The character data to be written. It's the callee's responsibility to
325N/A * escape special characters (such as &lt;, &gt;, and &amp;) in this buffer.
325N/A */
325N/A void text(StringBuilder text);
325N/A
325N/A /**
325N/A * Writes CDATA.
325N/A */
325N/A void cdata(StringBuilder text);
325N/A
325N/A /**
325N/A * Writes a comment.
325N/A *
325N/A * @throws UnsupportedOperationException
325N/A * if the writer doesn't support writing a comment, it can throw this exception.
325N/A */
325N/A void comment(StringBuilder comment);
325N/A
325N/A /**
325N/A * The last method to be called.
325N/A */
325N/A void endDocument();
325N/A
325N/A /**
325N/A * Flush the buffer.
325N/A *
325N/A * This method is called when applications invoke {@link TypedXmlWriter#commit(boolean)}
325N/A * method. If the implementation performs any buffering, it should flush the buffer.
325N/A */
325N/A void flush();
325N/A}