org.dita.dost.util

Class XMLSerializer

java.lang.Object

org.dita.dost.util.XMLSerializer

public class XMLSerializer
extends java.lang.Object

XML serializer. Users a TransformerHandler as the underlying serializer.

When possible, use XMLStreamWriter instead.

Not thread-safe.

Since:

1.5.3

Method Summary

Modifier and Type	Method and Description
void	close() Close output.
javax.xml.transform.sax.TransformerHandler	getTransformerHandler() Get underlying serializer.
static XMLSerializer	newInstance(java.io.OutputStream out) Get serializer instance.
static XMLSerializer	newInstance(java.io.Writer out) Get serializer instance.
void	writeAttribute(java.lang.String qName, java.lang.String value) Write attribute
void	writeAttribute(java.lang.String uri, java.lang.String qName, java.lang.String value) Write attribute
void	writeCharacters(char[] ch, int start, int length) Write characters.
void	writeCharacters(java.lang.String text) Write characters.
void	writeComment(java.lang.String data) Write comment.
void	writeEndDocument() End document.
void	writeEndElement() Write end element.
void	writeNamespace(java.lang.String prefix, java.lang.String uri) Write namepace prefix.
void	writeProcessingInstruction(java.lang.String target, java.lang.String data) Write processing instruction.
void	writeStartDocument() Start document.
void	writeStartElement(java.lang.String qName) Write start element without attributes.
void	writeStartElement(java.lang.String uri, java.lang.String qName) Write start element without attributes.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static XMLSerializer newInstance(java.io.OutputStream out)

Get serializer instance.

Parameters:

out - output stream

newInstance

public static XMLSerializer newInstance(java.io.Writer out)

Get serializer instance.

Parameters:

out - output writer

getTransformerHandler

public javax.xml.transform.sax.TransformerHandler getTransformerHandler()

Get underlying serializer.

Returns:

serialization handler

close

public void close()
           throws java.io.IOException

Close output.

Throws:

java.io.IOException - if closing result output failed

writeStartDocument

public void writeStartDocument()
                        throws org.xml.sax.SAXException

Start document.

Throws:

org.xml.sax.SAXException - if processing the event failed

writeEndDocument

public void writeEndDocument()
                      throws org.xml.sax.SAXException

End document.

Throws:

org.xml.sax.SAXException - if processing the event failed

writeStartElement

public void writeStartElement(java.lang.String qName)
                       throws org.xml.sax.SAXException

Write start element without attributes.

Parameters:

qName - element QName

Throws:

org.xml.sax.SAXException - if processing the event failed

writeStartElement

public void writeStartElement(java.lang.String uri,
                              java.lang.String qName)
                       throws org.xml.sax.SAXException

Write start element without attributes.

Parameters:

qName - element QName

Throws:

org.xml.sax.SAXException - if processing the event failed

writeNamespace

public void writeNamespace(java.lang.String prefix,
                           java.lang.String uri)

Write namepace prefix.

Parameters:

prefix - namespace prefix

uri - namespace URI

Throws:

java.lang.IllegalStateException - if start element is not open

java.lang.IllegalArgumentException - if prefix is already bound

writeAttribute

public void writeAttribute(java.lang.String qName,
                           java.lang.String value)

Write attribute

Parameters:

qName - attribute name

value - attribute value

Throws:

java.lang.IllegalStateException - if start element is not open

writeAttribute

public void writeAttribute(java.lang.String uri,
                           java.lang.String qName,
                           java.lang.String value)

Write attribute

Parameters:

uri - namespace URI

qName - attribute name

value - attribute value

Throws:

java.lang.IllegalStateException - if start element is not open

writeEndElement

public void writeEndElement()
                     throws org.xml.sax.SAXException

Write end element.

Throws:

org.xml.sax.SAXException - if processing the event failed

writeCharacters

public void writeCharacters(java.lang.String text)
                     throws org.xml.sax.SAXException

Write characters.

Parameters:

text - character data

Throws:

org.xml.sax.SAXException - if processing the event failed

java.lang.IllegalStateException - if start element is not open

writeCharacters

public void writeCharacters(char[] ch,
                            int start,
                            int length)
                     throws org.xml.sax.SAXException

Write characters.

Parameters:

ch - character data array

start - start index

length - length data to write

Throws:

org.xml.sax.SAXException - if processing the event failed

java.lang.IllegalStateException - if start element is not open

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String target,
                                       java.lang.String data)
                                throws org.xml.sax.SAXException

Write processing instruction.

Parameters:

target - processing instruction name

data - processing instruction data, null if no data

Throws:

org.xml.sax.SAXException - if processing the event failed

writeComment

public void writeComment(java.lang.String data)
                  throws org.xml.sax.SAXException

Write comment.

Parameters:

data - comment data

Throws:

org.xml.sax.SAXException - if processing the event failed