All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.xml.txw2.output.XmlSerializer Maven / Gradle / Ivy

Go to download

Old JAXB Core module. Contains sources required by XJC, JXC and Runtime modules with dependencies.

There is a newer version: 4.0.5
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.xml.txw2.output;

import com.sun.xml.txw2.TypedXmlWriter;


/**
 * Low-level typeless XML writer driven from {@link TypedXmlWriter}.
 *
 * 

* Applications can use one of the predefined implementations to * send TXW output to the desired location/format, or they can * choose to implement this interface for custom output. * *

* One {@link XmlSerializer} instance is responsible for writing * one XML document. * *

Call Sequence

* TXW calls methods on this interface in the following order: * *
 * WHOLE_SEQUENCE := startDocument ELEMENT endDocument
 * ELEMENT := beginStartTag writeXmlns* writeAttribute* endStartTag CONTENT endTag
 * CONTENT := (text|ELEMENT)*
 * 
* *

* TXW maintains all the in-scope namespace bindings and prefix allocation. * The {@link XmlSerializer} implementation should just use the prefix * specified. *

* * @author Kohsuke Kawaguchi ([email protected]) */ public interface XmlSerializer { /** * The first method to be called. */ void startDocument(); /** * Begins writing a start tag. * * @param uri * the namespace URI of the element. Can be empty but never be null. * @param prefix * the prefix that should be used for this element. Can be empty, * but never null. */ void beginStartTag(String uri,String localName,String prefix); /** * Writes an attribute. * * @param value * The value of the attribute. It's the callee's responsibility to * escape special characters (such as <, >, and &) in this buffer. * * @param uri * the namespace URI of the attribute. Can be empty but never be null. * @param prefix * the prefix that should be used for this attribute. Can be empty, * but never null. */ void writeAttribute(String uri,String localName,String prefix,StringBuilder value); /** * Writes a namespace declaration. * * @param uri * the namespace URI to be declared. Can be empty but never be null. * @param prefix * the prefix that is allocated. Can be empty but never be null. */ void writeXmlns(String prefix,String uri); /** * Completes the start tag. * * @param uri * the namespace URI of the element. Can be empty but never be null. * @param prefix * the prefix that should be used for this element. Can be empty, * but never null. */ void endStartTag(String uri,String localName,String prefix); /** * Writes an end tag. */ void endTag(); /** * Writes PCDATA. * * @param text * The character data to be written. It's the callee's responsibility to * escape special characters (such as <, >, and &) in this buffer. */ void text(StringBuilder text); /** * Writes CDATA. */ void cdata(StringBuilder text); /** * Writes a comment. * * @throws UnsupportedOperationException * if the writer doesn't support writing a comment, it can throw this exception. */ void comment(StringBuilder comment); /** * The last method to be called. */ void endDocument(); /** * Flush the buffer. * * This method is called when applications invoke {@link TypedXmlWriter#commit(boolean)} * method. If the implementation performs any buffering, it should flush the buffer. */ void flush(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy