Package javanet.staxutils.io
Class StAXStreamWriter
- java.lang.Object
-
- javanet.staxutils.io.StAXStreamWriter
-
- All Implemented Interfaces:
XMLStreamWriter
public class StAXStreamWriter extends Object implements XMLStreamWriter
AnXMLStreamWriterimplementation that writes to a character stream.- Version:
- $Revision: 1.1 $
- Author:
- Christian Niles
-
-
Constructor Summary
Constructors Constructor Description StAXStreamWriter(OutputStream stream)Constructs aStAXStreamWriterthat writes to the providedOutputStreamusing the platform default encoding.StAXStreamWriter(OutputStream stream, String encoding)Constructs aStAXStreamWriterthat writes to the providedOutputStreamusing the specified encoding.StAXStreamWriter(Writer writer)Constructs aStAXStreamWriterthat writes to the providedWriter.StAXStreamWriter(Writer writer, NamespaceContext rootContext)Constructs aStAXStreamWriterthat writes to the providedWriter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()protected voidcloseElementContext()Closes the currentElementContext, writing any cached content and making it read-only.voidflush()StringgetCurrentPath()Returns the current position of the writer as a path ofQNamestrings.NamespaceContextgetNamespaceContext()StringgetPrefix(String uri)ObjectgetProperty(String name)voidsetDefaultNamespace(String uri)voidsetNamespaceContext(NamespaceContext context)voidsetPrefix(String prefix, String uri)voidwriteAttribute(String localName, String value)voidwriteAttribute(String namespaceURI, String localName, String value)voidwriteAttribute(String prefix, String namespaceURI, String localName, String value)voidwriteAttribute(QName name, String value)voidwriteCData(String data)voidwriteCharacters(char[] text, int start, int len)voidwriteCharacters(String text)voidwriteComment(String data)voidwriteDefaultNamespace(String namespaceURI)voidwriteDTD(String dtd)voidwriteEmptyElement(String localName)voidwriteEmptyElement(String namespaceURI, String localName)voidwriteEmptyElement(String prefix, String localName, String namespaceURI)voidwriteEndDocument()voidwriteEndElement()voidwriteEntityRef(String name)voidwriteNamespace(String prefix, String namespaceURI)voidwriteProcessingInstruction(String target)voidwriteProcessingInstruction(String target, String data)voidwriteStartDocument()voidwriteStartDocument(String version)voidwriteStartDocument(String encoding, String version)voidwriteStartElement(String localName)voidwriteStartElement(String namespaceURI, String localName)voidwriteStartElement(String prefix, String localName, String namespaceURI)voidwriteStartElement(String prefix, String localName, String namespaceURI, boolean isEmpty)Core start tag output method called by all otherwriteXXXElementmethods.
-
-
-
Constructor Detail
-
StAXStreamWriter
public StAXStreamWriter(OutputStream stream)
Constructs aStAXStreamWriterthat writes to the providedOutputStreamusing the platform default encoding.- Parameters:
stream- The destination stream.
-
StAXStreamWriter
public StAXStreamWriter(OutputStream stream, String encoding) throws UnsupportedEncodingException
Constructs aStAXStreamWriterthat writes to the providedOutputStreamusing the specified encoding.- Parameters:
stream- The destination stream.encoding- The output encoding.- Throws:
UnsupportedEncodingException- If the encoding isn't supported.
-
StAXStreamWriter
public StAXStreamWriter(Writer writer)
Constructs aStAXStreamWriterthat writes to the providedWriter.- Parameters:
writer- The destinationWriterinstance.
-
StAXStreamWriter
public StAXStreamWriter(Writer writer, NamespaceContext rootContext)
Constructs aStAXStreamWriterthat writes to the providedWriter.- Parameters:
writer- The destinationWriterinstance.rootContext- The root namespace context.
-
-
Method Detail
-
close
public void close() throws XMLStreamException- Specified by:
closein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
flush
public void flush() throws XMLStreamException- Specified by:
flushin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getPrefix
public String getPrefix(String uri) throws XMLStreamException
- Specified by:
getPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getProperty
public Object getProperty(String name) throws IllegalArgumentException
- Specified by:
getPropertyin interfaceXMLStreamWriter- Throws:
IllegalArgumentException
-
writeStartDocument
public void writeStartDocument() throws XMLStreamException- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument(String version) throws XMLStreamException
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartDocument
public void writeStartDocument(String encoding, String version) throws XMLStreamException
- Specified by:
writeStartDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndDocument
public void writeEndDocument() throws XMLStreamException- Specified by:
writeEndDocumentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCData
public void writeCData(String data) throws XMLStreamException
- Specified by:
writeCDatain interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeCharacters
public void writeCharacters(String text) throws XMLStreamException
- Specified by:
writeCharactersin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeComment
public void writeComment(String data) throws XMLStreamException
- Specified by:
writeCommentin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDTD
public void writeDTD(String dtd) throws XMLStreamException
- Specified by:
writeDTDin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEntityRef
public void writeEntityRef(String name) throws XMLStreamException
- Specified by:
writeEntityRefin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(String target, String data) throws XMLStreamException
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeProcessingInstruction
public void writeProcessingInstruction(String target) throws XMLStreamException
- Specified by:
writeProcessingInstructionin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getNamespaceContext
public NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContextin interfaceXMLStreamWriter
-
setNamespaceContext
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException
- Specified by:
setNamespaceContextin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setDefaultNamespace
public void setDefaultNamespace(String uri) throws XMLStreamException
- Specified by:
setDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
setPrefix
public void setPrefix(String prefix, String uri) throws XMLStreamException
- Specified by:
setPrefixin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI, boolean isEmpty) throws XMLStreamException
Core start tag output method called by all otherwriteXXXElementmethods.- Parameters:
prefix- The tag prefix.localName- The tag local name.namespaceURI- The namespace URI of the prefix.isEmpty- Whether the tag is empty.- Throws:
XMLStreamException- If an error occurs writing the tag to the stream.
-
writeStartElement
public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeStartElement
public void writeStartElement(String localName) throws XMLStreamException
- Specified by:
writeStartElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEmptyElement
public void writeEmptyElement(String localName) throws XMLStreamException
- Specified by:
writeEmptyElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(QName name, String value) throws XMLStreamException
- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeAttribute
public void writeAttribute(String localName, String value) throws XMLStreamException
- Specified by:
writeAttributein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeDefaultNamespace
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException
- Specified by:
writeDefaultNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeNamespace
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException
- Specified by:
writeNamespacein interfaceXMLStreamWriter- Throws:
XMLStreamException
-
writeEndElement
public void writeEndElement() throws XMLStreamException- Specified by:
writeEndElementin interfaceXMLStreamWriter- Throws:
XMLStreamException
-
getCurrentPath
public String getCurrentPath()
Returns the current position of the writer as a path ofQNamestrings.- Returns:
- The current position of the writer.
-
closeElementContext
protected void closeElementContext() throws XMLStreamExceptionCloses the currentElementContext, writing any cached content and making it read-only. If the current context is empty, it will be popped and replaced with its parent context. If no context is open, this method has no effects.- Throws:
XMLStreamException- If an error occurs flushing any element content.
-
-