Package com.sun.xml.txw2.output

Class StreamSerializer

java.lang.Object

com.sun.xml.txw2.output.StreamSerializer

All Implemented Interfaces:

XmlSerializer

public class StreamSerializer
extends Object
implements XmlSerializer

XmlSerializer for StreamResult.

Author:

[email protected]

Constructor Summary

Constructors

Constructor	Description
StreamSerializer(OutputStream out)
StreamSerializer(OutputStream out, String encoding)
StreamSerializer(Writer out)
StreamSerializer(StreamResult streamResult)

Method Summary

Modifier and Type	Method	Description
void	beginStartTag(String uri, String localName, String prefix)	Begins writing a start tag.
void	cdata(StringBuilder text)	Writes CDATA.
void	comment(StringBuilder comment)	Writes a comment.
void	endDocument()	The last method to be called.
void	endStartTag(String uri, String localName, String prefix)	Completes the start tag.
void	endTag()	Writes an end tag.
void	flush()	Flush the buffer.
void	startDocument()	The first method to be called.
void	text(StringBuilder text)	Writes PCDATA.
void	writeAttribute(String uri, String localName, String prefix, StringBuilder value)	Writes an attribute.
void	writeXmlns(String prefix, String uri)	Writes a namespace declaration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamSerializer

public StreamSerializer(OutputStream out)

StreamSerializer

public StreamSerializer(OutputStream out,
                        String encoding)
                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

StreamSerializer

public StreamSerializer(Writer out)

StreamSerializer

public StreamSerializer(StreamResult streamResult)

Method Detail

startDocument

public void startDocument()

Description copied from interface: XmlSerializer

The first method to be called.

Specified by:

startDocument in interface XmlSerializer

beginStartTag

public void beginStartTag(String uri,
                          String localName,
                          String prefix)

Description copied from interface: XmlSerializer

Begins writing a start tag.

Specified by:

beginStartTag in interface XmlSerializer

Parameters:

uri - the namespace URI of the element. Can be empty but never be null.

prefix - the prefix that should be used for this element. Can be empty, but never null.

writeAttribute

public void writeAttribute(String uri,
                           String localName,
                           String prefix,
                           StringBuilder value)

Description copied from interface: XmlSerializer

Writes an attribute.

Specified by:

writeAttribute in interface XmlSerializer

Parameters:

uri - the namespace URI of the attribute. Can be empty but never be null.

prefix - the prefix that should be used for this attribute. Can be empty, but never null.

value - The value of the attribute. It's the callee's responsibility to escape special characters (such as <, >, and &) in this buffer.

writeXmlns

public void writeXmlns(String prefix,
                       String uri)

Description copied from interface: XmlSerializer

Writes a namespace declaration.

Specified by:

writeXmlns in interface XmlSerializer

Parameters:

prefix - the prefix that is allocated. Can be empty but never be null.

uri - the namespace URI to be declared. Can be empty but never be null.

endStartTag

public void endStartTag(String uri,
                        String localName,
                        String prefix)

Description copied from interface: XmlSerializer

Completes the start tag.

Specified by:

endStartTag in interface XmlSerializer

Parameters:

uri - the namespace URI of the element. Can be empty but never be null.

prefix - the prefix that should be used for this element. Can be empty, but never null.

endTag

public void endTag()

Description copied from interface: XmlSerializer

Writes an end tag.

Specified by:

endTag in interface XmlSerializer

text

public void text(StringBuilder text)

Description copied from interface: XmlSerializer

Writes PCDATA.

Specified by:

text in interface XmlSerializer

Parameters:

text - The character data to be written. It's the callee's responsibility to escape special characters (such as <, >, and &) in this buffer.

cdata

public void cdata(StringBuilder text)

Description copied from interface: XmlSerializer

Writes CDATA.

Specified by:

cdata in interface XmlSerializer

comment

public void comment(StringBuilder comment)

Description copied from interface: XmlSerializer

Writes a comment.

Specified by:

comment in interface XmlSerializer

endDocument

public void endDocument()

Description copied from interface: XmlSerializer

The last method to be called.

Specified by:

endDocument in interface XmlSerializer

flush

public void flush()

Description copied from interface: XmlSerializer

Flush the buffer. This method is called when applications invoke TypedXmlWriter.commit(boolean) method. If the implementation performs any buffering, it should flush the buffer.

Specified by:

flush in interface XmlSerializer