com.revolsys.io.xml

Class XmlWriter

java.lang.Object

java.io.Writer

com.revolsys.io.xml.XmlWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

KmlXmlWriter

public class XmlWriter
extends Writer

The XmlWriter class is a subclass of Writer that provides additional methods to write XML documents.

Author:

Paul Austin

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
XmlWriter(OutputStream out) Construct a new XmlWriter.
XmlWriter(OutputStream out, boolean useNamespaces) Construct a new XmlWriter that optionally ignores namespaces.
XmlWriter(Writer out) Construct a new XmlWriter.
XmlWriter(Writer out, boolean useNamespaces) Construct a new XmlWriter that optionally ignores namespaces.

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(QName attribute, boolean value) Add an attribute to the current open tag.
void	attribute(QName attribute, byte value) Add an attribute to the current open tag.
void	attribute(QName attribute, double value) Add an attribute to the current open tag.
void	attribute(QName attribute, float value) Add an attribute to the current open tag.
void	attribute(QName attribute, int value) Add an attribute to the current open tag.
void	attribute(QName attribute, long value) Add an attribute to the current open tag.
void	attribute(QName attribute, Object value) Add an attribute to the current open tag.
void	attribute(QName attribute, String value) Add an attribute to the current open tag.
void	attribute(String name, Object value)
void	attribute(String name, String value)
void	cdata(String text) Write the contents in a CDATA section.
void	close() Close the underlying output stream or writer.
void	closeStartTag() Close the current open start tag.
void	comment(String comment) Write an XML comment.
void	docType(String dtd) Write a DTD section.
void	docType(String name, String systemId) Write a DOCTYPE declaration using a SYSTEM identifier.
void	docType(String name, String publicId, String systemId) Write a DOCTYPE declaration using a PUBLIC identifier.
void	element(QName element, Object content) Write the element with the specified content.
void	element(String local, Object content)
void	emptyTag(QName element) Write an empty tag.
void	endDocument() End a document, closing all tags and flushing the output.
void	endTag() Write the end tag for the current element.
void	endTag(QName element) Write the end tag for an element.
void	endTag(String localPart)
void	endTagLn(QName element)
void	entityRef(char ch) Write the entity reference for the specified character.
void	entityRef(String name) Write the entity reference with the specified text.
void	flush() Flush the output closing the current start tag.
String	getPrefix(String namespaceUri) Get the prefix for the XML Namespace URI.
boolean	isIndent() Get the flag indicating that the xml elements should be indented.
boolean	isWriteNewLine()
void	newLine() Write a newLine to the writer.
void	nillableElement(QName element, Object content) Write the element with the specified content, if null xsi:nil attribute will be set.
void	processingInstruction(String target, String value) Write an XML processing instruction.
void	setElementHasContent()
void	setIndent(boolean indent) Set the flag indicating that the xml elements should be indented.
void	setNamespaceAlias(String namespaceUri, String alias)
void	setPrefix(QName typePath)
void	setPrefix(String prefix, String namespaceUri) Set the prefix for the XML Namespace URI.
void	setWriteNewLine(boolean writeNewLine)
void	startDocument() Start a document with an empty XML Declaration.
void	startDocument(String encoding) Start a document with an XML Declaration for the specified encoding.
void	startDocument(String encoding, boolean standalone) Start a document with an XML Declaration for the specified encoding and the standalone flag.
void	startDocument(String encoding, Boolean standalone) Start a document with an XML Declaration for the specified encoding and the standalone flag (null will omit the flag).
void	startDocument(String encoding, String version) Start a document with an XML Declaration for the specified encoding.
void	startDocument(String encoding, String version, Boolean standalone) Start a document with an XML Declaration for the specified encoding and the standalone flag (null will omit the flag).
void	startTag(QName element) Write the start tag for an element.
void	startTag(String localPart)
void	startTag(String namespaceUri, String localPart) Write the start tag for an element.
void	startTagLn(QName element)
void	text(boolean value) Write the boolean value as the content of a tag with special characters escaped.
void	text(char[] buffer, int offset, int length) Write a portion of the character buffer to the outpu, escaping special characters.
void	text(double value) Write the double value as the content of a tag with special characters escaped.
void	text(float value) Write the float value as the content of a tag with special characters escaped.
void	text(int value) Write the int value as the content of a tag with special characters escaped.
void	text(long value) Write the long value as the content of a tag with special characters escaped.
void	text(Object value) Write the object value as the content of a tag with special characters escaped.
void	text(String text) Write the text string to the output, escaping special characters.
void	write(char[] buffer) Write an array of characters.
void	write(char[] buffer, int offset, int length) Write a portion of an array of characters.
void	write(int character) Write a single character.
void	write(String string) Write a String.
void	write(String string, int offset, int length) Write a portion of a String.
protected void	writeAttributeContent(char[] buffer, int offset, int length) Write content for an attribute value to the output, escaping the characters that are used within markup.
protected void	writeAttributeValue(String value) Write the value of an attribute.
protected void	writeElementContent(char[] buffer, int offest, int length) Write content for an element to the output, escaping the characters that are used within markup.
void	writeNamespaceAttribute(String namespaceUri, String prefix)
void	xsiTypeAttribute(QName xsiTagName)

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWriter

public XmlWriter(OutputStream out)

Construct a new XmlWriter.

Parameters:

out - The output stream to write to.

XmlWriter

public XmlWriter(OutputStream out,
         boolean useNamespaces)

Construct a new XmlWriter that optionally ignores namespaces.

Parameters:

out - The output stream to write to.

useNamespaces - True if namespaces should be written, false if they should be ignored.

XmlWriter

public XmlWriter(Writer out)

Construct a new XmlWriter.

Parameters:

out - The writer to write to.

XmlWriter

public XmlWriter(Writer out,
         boolean useNamespaces)

Construct a new XmlWriter that optionally ignores namespaces.

Parameters:

out - The writer to write to.

useNamespaces - True if namespaces should be written, false if they should be ignored.

Method Detail

attribute

public void attribute(QName attribute,
             boolean value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             byte value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             double value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             float value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             int value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             long value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             Object value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(QName attribute,
             String value)

Add an attribute to the current open tag.

Parameters:

attribute - The QName of the attribute.

value - The attribute value.

Throws:

IOException - If there was an error writing.

IllegalStateException - If a start tag is not open.

attribute

public void attribute(String name,
             Object value)

attribute

public void attribute(String name,
             String value)

cdata

public void cdata(String text)

Write the contents in a CDATA section. No escaping will be done on the data the text must not contain "]]>".

Parameters:

text - The text to wrap in a CDATA section

Throws:

IOException - If there was a problem writing the text

close

public void close()

Close the underlying output stream or writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException - If the output stream or writer could not be closed.

closeStartTag

public void closeStartTag()

Close the current open start tag. If a start tag is not open then no action will be taken.

Throws:

IOException - If there was an error writing.

comment

public void comment(String comment)

Write an XML comment. The comment should not contain the string '--'.

Parameters:

comment - The comment to write

Throws:

IOException - If there was a problem writing the comment

docType

public void docType(String dtd)

Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.

Parameters:

dtd - The DTD to be written

Throws:

IOException - If there was a problem writing the declaration

docType

public void docType(String name,
           String systemId)

Write a DOCTYPE declaration using a SYSTEM identifier.

Parameters:

name - The root element name

systemId - The system id

Throws:

IOException - If there was a problem writing the declaration

docType

public void docType(String name,
           String publicId,
           String systemId)

Write a DOCTYPE declaration using a PUBLIC identifier.

Parameters:

name - The root element name.

publicId - The public id.

systemId - The system id.

Throws:

IOException - If there was a problem writing the declaration.

element

public void element(QName element,
           Object content)

Write the element with the specified content.

Parameters:

element - The QName of the tag.

content - The body context for the element.

Throws:

IOException - If there was a problem writing the element.

element

public void element(String local,
           Object content)

emptyTag

public void emptyTag(QName element)

Write an empty tag.

Parameters:

element - The QName of the tag.

Throws:

IOException - If there was a problem writing the tag.

endDocument

public void endDocument()

End a document, closing all tags and flushing the output.

Throws:

IOException - If the document could not be ended

endTag

public void endTag()

Write the end tag for the current element. If the element has no content it will be written as an empty tag.

Throws:

IOException - If there was a problem writing the element.

endTag

public void endTag(QName element)

Write the end tag for an element. If the element has no content it will be written as an empty tag.

Parameters:

element - The QName of the tag.

Throws:

IOException - If there was a problem writing the element.

endTag

public void endTag(String localPart)

endTagLn

public void endTagLn(QName element)

entityRef

public void entityRef(char ch)

Write the entity reference for the specified character.

Parameters:

ch - The character to write the entity for

Throws:

IOException - If there was a problem writing the entity

entityRef

public void entityRef(String name)

Write the entity reference with the specified text.

Parameters:

name - The name of the entity

Throws:

IOException - If there was a problem writing the entity

flush

public void flush()

Flush the output closing the current start tag.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException - If there was an exception flushing the writer.

getPrefix

public String getPrefix(String namespaceUri)

Get the prefix for the XML Namespace URI.

Parameters:

namespaceUri - The XML Namespace URI.

Returns:

The prefix.

isIndent

public boolean isIndent()

Get the flag indicating that the xml elements should be indented.

Returns:

The flag indicating that the xml elements should be indented.

isWriteNewLine

public boolean isWriteNewLine()

newLine

public void newLine()

Write a newLine to the writer. If an XML start tag is open it will be closed before the new line is written.

Throws:

IOException - If there was an exception writing the new line.

nillableElement

public void nillableElement(QName element,
                   Object content)

Write the element with the specified content, if null xsi:nil attribute will be set.

Parameters:

element - The QName of the tag.

content - The body context for the element.

Throws:

IOException - If there was a problem writing the element.

processingInstruction

public void processingInstruction(String target,
                         String value)

Write an XML processing instruction.

Parameters:

target - The PI Target (must not be xml)

value - The value of the processing instruction

Throws:

IOException - If there was a problem writing the comment

setElementHasContent

public void setElementHasContent()

setIndent

public void setIndent(boolean indent)

Set the flag indicating that the xml elements should be indented.

Parameters:

indent - The flag indicating that the xml elements should be indented.

setNamespaceAlias

public void setNamespaceAlias(String namespaceUri,
                     String alias)

setPrefix

public void setPrefix(QName typePath)

setPrefix

public void setPrefix(String prefix,
             String namespaceUri)

Set the prefix for the XML Namespace URI.

Parameters:

prefix - The prefix.

namespaceUri - The XML Namespace URI.

setWriteNewLine

public void setWriteNewLine(boolean writeNewLine)

startDocument

public void startDocument()

Start a document with an empty XML Declaration.

Throws:

IOException - If there was a problem writing the XML Declaration.

startDocument

public void startDocument(String encoding)

Start a document with an XML Declaration for the specified encoding.

Parameters:

encoding - The encoding for the document

Throws:

IOException - If there was a problem writing the XML Declaration.

startDocument

public void startDocument(String encoding,
                 boolean standalone)

Start a document with an XML Declaration for the specified encoding and the standalone flag.

Parameters:

encoding - The encoding for the document

standalone - The standalone flag

Throws:

IOException - If there was a problem writing the XML Declaration.

startDocument

public void startDocument(String encoding,
                 Boolean standalone)

Start a document with an XML Declaration for the specified encoding and the standalone flag (null will omit the flag).

Parameters:

encoding - The encoding for the document

standalone - The standalone flag

Throws:

IOException - If there was a problem writing the XML Declaration.

startDocument

public void startDocument(String encoding,
                 String version)

Start a document with an XML Declaration for the specified encoding.

Parameters:

encoding - The encoding for the document

version - The XML version.

Throws:

IOException - If there was a problem writing the XML Declaration.

startDocument

public void startDocument(String encoding,
                 String version,
                 Boolean standalone)

Start a document with an XML Declaration for the specified encoding and the standalone flag (null will omit the flag).

Parameters:

encoding - The encoding for the document

version - The XML version.

standalone - The standalone flag

Throws:

IOException - If there was a problem writing the XML Declaration.

startTag

public void startTag(QName element)

Write the start tag for an element.

Parameters:

element - The QName of the tag.

Throws:

IOException - If there was a problem writing the element.

startTag

public void startTag(String localPart)

startTag

public void startTag(String namespaceUri,
            String localPart)

Write the start tag for an element.

Parameters:

namespaceUri - The namespace URI.

localPart - The local name.

Throws:

IOException - If there was a problem writing the element.

startTagLn

public void startTagLn(QName element)

text

public void text(boolean value)

Write the boolean value as the content of a tag with special characters escaped.

Parameters:

value - The value.

Throws:

IOException - If there was a problem writing the text.

text

public void text(char[] buffer,
        int offset,
        int length)

Write a portion of the character buffer to the outpu, escaping special characters.

Parameters:

buffer - The buffer to write.

offset - The starting offset in the buffer.

length - The number of characters to write.

Throws:

IOException - If there was a problem writing the text.

text

public void text(double value)

Write the double value as the content of a tag with special characters escaped.

Parameters:

value - The value.

Throws:

IOException - If there was a problem writing the text.

text

public void text(float value)

Write the float value as the content of a tag with special characters escaped.

Parameters:

value - The value.

Throws:

IOException - If there was a problem writing the text.

text

public void text(int value)

Write the int value as the content of a tag with special characters escaped.

Parameters:

value - The value.

Throws:

IOException - If there was a problem writing the text.

text

public void text(long value)

Write the long value as the content of a tag with special characters escaped.

Parameters:

value - The value.

Throws:

IOException - If there was a problem writing the text.

text

public void text(Object value)

Write the object value as the content of a tag with special characters escaped. If the value is null it will not be written.

Parameters:

value - The value.

Throws:

IOException - If there was a problem writing the text.

text

public void text(String text)

Write the text string to the output, escaping special characters.

Parameters:

text - The text to write

Throws:

IOException - If there was a problem writing the text

write

public void write(char[] buffer)

Write an array of characters.

Overrides:

write in class Writer

Parameters:

buffer - The character buffer to write.

Throws:

IOException - If an I/O exception occurs.

write

public void write(char[] buffer,
         int offset,
         int length)

Write a portion of an array of characters.

Specified by:

write in class Writer

Parameters:

buffer - The character buffer to write.

offset - The starting offset in the buffer.

length - The number of characters to write.

Throws:

IOException - If an I/O exception occurs.

write

public void write(int character)

Write a single character.

Overrides:

write in class Writer

Parameters:

character - The character to write.

Throws:

IOException - If an I/O exception occurs.

write

public void write(String string)

Write a String.

Overrides:

write in class Writer

Parameters:

string - The String to write.

Throws:

IOException - If an I/O exception occurs.

write

public void write(String string,
         int offset,
         int length)

Write a portion of a String.

Overrides:

write in class Writer

Parameters:

string - The String to write.

offset - The starting offset in the buffer.

length - The number of characters to write.

Throws:

IOException - If an I/O exception occurs.

writeAttributeContent

protected void writeAttributeContent(char[] buffer,
                         int offset,
                         int length)

Write content for an attribute value to the output, escaping the characters that are used within markup. This method will escape characters ' <', '>', '&', 9, 10, 13 and '"'. Note the XML 1.0 standard does allow '>' to be used unless it is part of "]]>" for simplicity it is allways escaped in this implementation.

Parameters:

buffer - The character buffer to write

offset - The offset in the character data to write

length - The number of characters to write.

Throws:

IOException - If an I/O exception occurs.

writeAttributeValue

protected void writeAttributeValue(String value)

Write the value of an attribute.

Parameters:

value - The value to write.

Throws:

IOException - If an I/O exception occurs.

writeElementContent

protected void writeElementContent(char[] buffer,
                       int offest,
                       int length)

Write content for an element to the output, escaping the characters that are used within markup. This method will escape characters ' <', '>' and '&'. Note the XML 1.0 standard does allow '>' to be used unless it is part of "]]>" for simplicity it is allways escaped in this implementation.

Parameters:

buffer - The character buffer to write

offest - The offset in the character data to write

length - The number of characters to write.

Throws:

IOException - If an I/O exception occurs.

writeNamespaceAttribute

public void writeNamespaceAttribute(String namespaceUri,
                           String prefix)

xsiTypeAttribute

public void xsiTypeAttribute(QName xsiTagName)