com.adobe.internal.xmp.utils

Class XMLStreamWriterImpl

java.lang.Object

com.adobe.internal.xmp.utils.XMLStreamWriterImpl

public class XMLStreamWriterImpl
extends Object

Uncomplete implementation of XMPStreamWriter of the upcoming XML Streaming API, that is adapted to be used for XMPCore. Adds automatically correct closing of empty tags > and pretty printing. Simplifies namespace handling; just tracks if a certain prefix has already been registered. FfF: If StAX will become part of the JRE, it might be replaced.

Since:

09.11.2006

Version:

$Revision$

Author:

Stefan Makswit

Constructor Summary

Constructors

Constructor and Description
XMLStreamWriterImpl(Writer writer) Default constructor providing a writer the XML is written to.
XMLStreamWriterImpl(Writer writer, SerializeOptions options) Default constructor providing a writer the XML is written to and the serializsation options to determine indents, whitespaces and lineendings.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the writer.
void	flush() Calls flush() on the writer.
void	setEscapeWhitespaces(boolean escapeWhitespaces)
void	writeAttribute(String qname, String value) Writes an attribute into an open tag.
void	writeCData(String data) Writes CData.
void	writeCharacters(char[] buffer, int off, int length) Writes a part of a char array.
void	writeCharacters(String text) Writes XML-characters.
void	writeComment(String comment) Writes a comment.
void	writeDefaultNamespace(String namespaceURI) Writes the default namespace
void	writeDTD(String dtd) Writes the DTD.
void	writeEmptyElement(String qname) Differs from writeStartElement in that writeEndElement needs and must not be called.
void	writeEndDocument() Completes the document by writing the end tags for all open tags.
void	writeEndElement() Writes a closing tag if the tag in scope has body elements or > if its empty.
void	writeEntityRef(String name) Writes an entity reference.
void	writeNamespace(String prefix, String namespaceURI) Writes a namespace attribute and tracks if the namespace is already defined.
void	writeProcessingInstruction(String target) Writes a processing instruction.
void	writeProcessingInstruction(String target, String text) Writes a processing instruction.
void	writeStartDocument() Writes the XML-header and version.
void	writeStartDocument(String version) Writes the XML-header and version.
void	writeStartDocument(String encoding, String version) Writes the XML-header, encoding and version.
void	writeStartElement(String qname) Writes a start tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStreamWriterImpl

public XMLStreamWriterImpl(Writer writer,
                           SerializeOptions options)

Default constructor providing a writer the XML is written to and the serializsation options to determine indents, whitespaces and lineendings.

Parameters:

writer - a Writer

options - the serialization options

XMLStreamWriterImpl

public XMLStreamWriterImpl(Writer writer)

Default constructor providing a writer the XML is written to.

Parameters:

writer - a Writer

Method Detail

writeStartElement

public void writeStartElement(String qname)
                       throws IOException

Writes a start tag.

Parameters:

qname - a QName

Throws:

IOException - If an I/O error occurs

writeEmptyElement

public void writeEmptyElement(String qname)
                       throws IOException

Differs from writeStartElement in that writeEndElement needs and must not be called.

Parameters:

qname - a QName

Throws:

IOException - If an I/O error occurs

writeEndElement

public void writeEndElement()
                     throws IOException

Writes a closing tag if the tag in scope has body elements or > if its empty.

Throws:

IOException - If an I/O error occurs

close

public void close()
           throws IOException

Closes the writer.

Throws:

IOException - If an I/O error occurs

flush

public void flush()
           throws IOException

Calls flush() on the writer.

Throws:

IOException - If an I/O error occurs

writeEndDocument

public void writeEndDocument()
                      throws IOException

Completes the document by writing the end tags for all open tags.

Throws:

IOException - If an I/O error occurs

writeAttribute

public void writeAttribute(String qname,
                           String value)
                    throws IOException

Writes an attribute into an open tag.

Parameters:

qname - a QName

value - the attribute value

Throws:

IOException - If an I/O error occurs

writeNamespace

public void writeNamespace(String prefix,
                           String namespaceURI)
                    throws IOException

Writes a namespace attribute and tracks if the namespace is already defined.

Parameters:

prefix - the namespace prefix.

namespaceURI - the namespace URI

Throws:

IOException - If an I/O error occurs

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceURI)
                           throws IOException

Writes the default namespace

Parameters:

namespaceURI - the default namespace

Throws:

IOException - If an I/O error occurs

writeComment

public void writeComment(String comment)
                  throws IOException

Writes a comment.

Parameters:

comment - the comment to write

Throws:

IOException - If an I/O error occurs

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws IOException

Writes a processing instruction.

Parameters:

target - a target

Throws:

IOException - If an I/O error occurs

writeProcessingInstruction

public void writeProcessingInstruction(String target,
                                       String text)
                                throws IOException

Writes a processing instruction.

Parameters:

target - a target

text - the instruction text

Throws:

IOException - If an I/O error occurs

writeDTD

public void writeDTD(String dtd)
              throws IOException

Writes the DTD.

Parameters:

dtd - the dtd to write

Throws:

IOException - If an I/O error occurs

writeCData

public void writeCData(String data)
                throws IOException

Writes CData.

Parameters:

data - the data to write

Throws:

IOException - If an I/O error occurs

writeEntityRef

public void writeEntityRef(String name)
                    throws IOException

Writes an entity reference.

Parameters:

name - the name of the reference

Throws:

IOException - If an I/O error occurs

writeStartDocument

public void writeStartDocument()
                        throws IOException

Writes the XML-header and version.

Throws:

IOException - If an I/O error occurs

writeStartDocument

public void writeStartDocument(String version)
                        throws IOException

Writes the XML-header and version.

Parameters:

version - th xml-version

Throws:

IOException - If an I/O error occurs

writeStartDocument

public void writeStartDocument(String encoding,
                               String version)
                        throws IOException

Writes the XML-header, encoding and version.

Parameters:

encoding - the file encoding

version - th XML-version

Throws:

IOException - If an I/O error occurs

writeCharacters

public void writeCharacters(String text)
                     throws IOException

Writes XML-characters.

Parameters:

text - xml characters

Throws:

IOException - If an I/O error occurs

writeCharacters

public void writeCharacters(char[] buffer,
                            int off,
                            int length)
                     throws IOException

Writes a part of a char array.

Parameters:

buffer - a character array

off - the offset within the array

length - the amount of character to write

Throws:

IOException - If an I/O error occurs

setEscapeWhitespaces

public void setEscapeWhitespaces(boolean escapeWhitespaces)

Parameters:

escapeWhitespaces - the escapeWhitespaces to set