com.revolsys.io.xml

Class StaxXmlWriter

java.lang.Object

com.revolsys.io.xml.StaxXmlWriter

All Implemented Interfaces:

XMLStreamWriter

public class StaxXmlWriter
extends Object
implements XMLStreamWriter

The StaxXmlWriter is a wrapper around an XmlWriter that implements the XMLStreamWriter interface from the StAX API.

Author:

Paul Austin

Constructor Summary

Constructors

Constructor and Description
StaxXmlWriter(XmlWriter writer)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close this writer and free any resources associated with the writer.
void	flush() Write any cached data to the underlying output mechanism.
NamespaceContext	getNamespaceContext() Get the current namespace context.
String	getPrefix(String namespaceUri) Get the prefix for the XML Namespace URI.
Object	getProperty(String name) Get the value of a feature/property from the underlying implementation.
void	setDefaultNamespace(String namespaceUri) Bind the namespace URI to the default namespace.
void	setNamespaceContext(NamespaceContext namespaceContext) Set the current namespace context.
void	setPrefix(String prefix, String namespaceUri) Set the prefix for the XML Namespace URI.
void	writeAttribute(String name, String value) Writes an attribute to the current start tag.
void	writeAttribute(String namespaceUri, String name, String value) Writes an attribute to the current start tag.
void	writeAttribute(String prefix, String namespaceUri, String name, String value) Writes an attribute to the current start tag.
void	writeCData(String text) Write the contents in a CDATA section.
void	writeCharacters(char[] buffer, int offset, int length) Write a portion of the character buffer to the outpu, escaping special characters.
void	writeCharacters(String text) Write the text string to the output, escaping special characters.
void	writeComment(String comment) Write an XML comment.
void	writeDefaultNamespace(String namespaceUri) Writes a default namespace to the output stream.
void	writeDTD(String dtd) Write a DTD section.
void	writeEmptyElement(String name) Writes an empty tag to the output.
void	writeEmptyElement(String namespaceUri, String name) Writes an empty tag to the output.
void	writeEmptyElement(String prefix, String name, String namespaceUri) Writes an empty tag to the output.
void	writeEndDocument() End a document, closing all tags and flushing the output.
void	writeEndElement() Writes an end tag to the output.
void	writeEntityRef(String name) Write the entity reference with the specified text.
void	writeNamespace(String prefix, String namespaceUri) Writes a namespace to the output stream.
void	writeProcessingInstruction(String target) Write an XML processing instruction.
void	writeProcessingInstruction(String target, String value) Write an XML processing instruction.
void	writeStartDocument() Start a document with an XML Declaration.
void	writeStartDocument(String encoding) Start a document with an XML Declaration.
void	writeStartDocument(String encoding, String version) Start a document with an XML Declaration.
void	writeStartElement(String name) Writes a start tag to the output.
void	writeStartElement(String namespaceUri, String name) Writes a start tag to the output.
void	writeStartElement(String prefix, String name, String namespaceUri) Writes a start tag to the output.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaxXmlWriter

public StaxXmlWriter(XmlWriter writer)

Parameters:

writer -

Method Detail

close

public void close()
           throws XMLStreamException

Close this writer and free any resources associated with the writer. Note: this underlying writer closes the stream so this method breaks from the StAX specification which says it must not close te underlying output stream.

Specified by:

close in interface XMLStreamWriter

Throws:

XMLStreamException - If an exception writing the XML occurs.

flush

public void flush()
           throws XMLStreamException

Write any cached data to the underlying output mechanism.

Specified by:

flush in interface XMLStreamWriter

Throws:

XMLStreamException - If an exception writing the XML occurs.

getNamespaceContext

public NamespaceContext getNamespaceContext()

Get the current namespace context.

Specified by:

getNamespaceContext in interface XMLStreamWriter

Returns:

The namespace context.

getPrefix

public String getPrefix(String namespaceUri)
                 throws XMLStreamException

Get the prefix for the XML Namespace URI.

Specified by:

getPrefix in interface XMLStreamWriter

Parameters:

namespaceUri - The XML Namespace URI.

Returns:

The prefix.

Throws:

XMLStreamException - If there was an exception getting the prefix.

getProperty

public Object getProperty(String name)

Get the value of a feature/property from the underlying implementation.

Specified by:

getProperty in interface XMLStreamWriter

Parameters:

name - The name of the property, may not be null.

Returns:

The value of the property.

setDefaultNamespace

public void setDefaultNamespace(String namespaceUri)
                         throws XMLStreamException

Bind the namespace URI to the default namespace.

Specified by:

setDefaultNamespace in interface XMLStreamWriter

Parameters:

namespaceUri - The XML Namespace URI.

Throws:

XMLStreamException - If there was an exception setting the prefix.

setNamespaceContext

public void setNamespaceContext(NamespaceContext namespaceContext)
                         throws XMLStreamException

Set the current namespace context.

Specified by:

setNamespaceContext in interface XMLStreamWriter

Parameters:

namespaceContext - The namespace context.

Throws:

XMLStreamException - If there was an error setting the context.

setPrefix

public void setPrefix(String prefix,
             String namespaceUri)
               throws XMLStreamException

Set the prefix for the XML Namespace URI.

Specified by:

setPrefix in interface XMLStreamWriter

Parameters:

prefix - The prefix.

namespaceUri - The XML Namespace URI.

Throws:

XMLStreamException - If there was an exception setting the prefix.

writeAttribute

public void writeAttribute(String name,
                  String value)
                    throws XMLStreamException

Writes an attribute to the current start tag.

Specified by:

writeAttribute in interface XMLStreamWriter

Parameters:

name - The local name of the element.

value - The value of the attribute

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeAttribute

public void writeAttribute(String namespaceUri,
                  String name,
                  String value)
                    throws XMLStreamException

Writes an attribute to the current start tag.

Specified by:

writeAttribute in interface XMLStreamWriter

Parameters:

name - The local name of the element.

namespaceUri - The XML Namespace URI of the element.

value - The value of the attribute

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeAttribute

public void writeAttribute(String prefix,
                  String namespaceUri,
                  String name,
                  String value)
                    throws XMLStreamException

Writes an attribute to the current start tag.

Specified by:

writeAttribute in interface XMLStreamWriter

Parameters:

prefix - The XML Namespace prefix of the element.

name - The local name of the element.

namespaceUri - The XML Namespace URI of the element.

value - The value of the attribute

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeCData

public void writeCData(String text)
                throws XMLStreamException

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

Specified by:

writeCData in interface XMLStreamWriter

Parameters:

text - The text to wrap in a CDATA section

Throws:

XMLStreamException - If there was a problem writing the text

writeCharacters

public void writeCharacters(char[] buffer,
                   int offset,
                   int length)
                     throws XMLStreamException

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

Specified by:

writeCharacters in interface XMLStreamWriter

Parameters:

buffer - The buffer to write.

offset - The starting offset in the buffer.

length - The number of characters to write.

Throws:

XMLStreamException - If there was a problem writing the text.

writeCharacters

public void writeCharacters(String text)
                     throws XMLStreamException

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

Specified by:

writeCharacters in interface XMLStreamWriter

Parameters:

text - The text to write

Throws:

XMLStreamException - If there was a problem writing the text

writeComment

public void writeComment(String comment)
                  throws XMLStreamException

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

Specified by:

writeComment in interface XMLStreamWriter

Parameters:

comment - The comment to write

Throws:

XMLStreamException - If there was a problem writing the comment

writeDefaultNamespace

public void writeDefaultNamespace(String namespaceUri)
                           throws XMLStreamException

Writes a default namespace to the output stream.

Specified by:

writeDefaultNamespace in interface XMLStreamWriter

Parameters:

namespaceUri - The XML Namespace URI.

Throws:

XMLStreamException - If there was a problem writing the namespace.

writeDTD

public void writeDTD(String dtd)
              throws XMLStreamException

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

Specified by:

writeDTD in interface XMLStreamWriter

Parameters:

dtd - The DTD to be written

Throws:

XMLStreamException - If there was a problem writing the declaration

writeEmptyElement

public void writeEmptyElement(String name)
                       throws XMLStreamException

Writes an empty tag to the output.

Specified by:

writeEmptyElement in interface XMLStreamWriter

Parameters:

name - The local name of the element.

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeEmptyElement

public void writeEmptyElement(String namespaceUri,
                     String name)
                       throws XMLStreamException

Writes an empty tag to the output.

Specified by:

writeEmptyElement in interface XMLStreamWriter

Parameters:

name - The local name of the element.

namespaceUri - The XML Namespace URI of the element.

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeEmptyElement

public void writeEmptyElement(String prefix,
                     String name,
                     String namespaceUri)
                       throws XMLStreamException

Writes an empty tag to the output.

Specified by:

writeEmptyElement in interface XMLStreamWriter

Parameters:

prefix - The XML Namespace prefix of the element.

name - The local name of the element.

namespaceUri - The XML Namespace URI of the element.

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

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

Specified by:

writeEndDocument in interface XMLStreamWriter

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Writes an end tag to the output.

Specified by:

writeEndElement in interface XMLStreamWriter

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeEntityRef

public void writeEntityRef(String name)
                    throws XMLStreamException

Write the entity reference with the specified text.

Specified by:

writeEntityRef in interface XMLStreamWriter

Parameters:

name - The name of the entity

Throws:

XMLStreamException - If there was a problem writing the entity

writeNamespace

public void writeNamespace(String prefix,
                  String namespaceUri)
                    throws XMLStreamException

Writes a namespace to the output stream.

Specified by:

writeNamespace in interface XMLStreamWriter

Parameters:

prefix - The prefix.

namespaceUri - The XML Namespace URI.

Throws:

XMLStreamException - If there was a problem writing the namespace.

writeProcessingInstruction

public void writeProcessingInstruction(String target)
                                throws XMLStreamException

Write an XML processing instruction.

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Parameters:

target - The PI Target (must not be xml)

Throws:

XMLStreamException - If there was a problem writing the comment

writeProcessingInstruction

public void writeProcessingInstruction(String target,
                              String value)
                                throws XMLStreamException

Write an XML processing instruction.

Specified by:

writeProcessingInstruction in interface XMLStreamWriter

Parameters:

target - The PI Target (must not be xml)

value - The value of the processing instruction

Throws:

XMLStreamException - If there was a problem writing the comment

writeStartDocument

public void writeStartDocument()
                        throws XMLStreamException

Start a document with an XML Declaration.

Specified by:

writeStartDocument in interface XMLStreamWriter

Throws:

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

writeStartDocument

public void writeStartDocument(String encoding)
                        throws XMLStreamException

Start a document with an XML Declaration.

Specified by:

writeStartDocument in interface XMLStreamWriter

Parameters:

encoding - The encoding for the XML declaration.

Throws:

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

writeStartDocument

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

Start a document with an XML Declaration.

Specified by:

writeStartDocument in interface XMLStreamWriter

Parameters:

encoding - The encoding for the XML declaration.

version -

Throws:

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

writeStartElement

public void writeStartElement(String name)
                       throws XMLStreamException

Writes a start tag to the output.

Specified by:

writeStartElement in interface XMLStreamWriter

Parameters:

name - The local name of the element.

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeStartElement

public void writeStartElement(String namespaceUri,
                     String name)
                       throws XMLStreamException

Writes a start tag to the output.

Specified by:

writeStartElement in interface XMLStreamWriter

Parameters:

namespaceUri - The XML Namespace URI of the element.

name - The local name of the element.

Throws:

XMLStreamException - If an exception writing the XML occurs.

writeStartElement

public void writeStartElement(String prefix,
                     String name,
                     String namespaceUri)
                       throws XMLStreamException

Writes a start tag to the output.

Specified by:

writeStartElement in interface XMLStreamWriter

Parameters:

prefix - The XML Namespace prefix of the element.

name - The local name of the element.

namespaceUri - The XML Namespace URI of the element.

Throws:

XMLStreamException - If an exception writing the XML occurs.