com.sun.xml.txw2.output.XmlSerializer Maven / Gradle / Ivy
/*
* Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
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 localName
* the local name of the element.
* @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 localName
* the local name of the attribute.
* @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 localName
* the local name of the element.
* @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.
* @param text CDATA
*/
void cdata(StringBuilder text);
/**
* Writes a comment.
*
* @param comment 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();
}