public class StAXStreamWriter extends java.lang.Object implements XMLStreamWriter
XMLStreamWriter
implementation that writes to a character stream.Constructor and Description |
---|
StAXStreamWriter(java.io.OutputStream stream)
Constructs a
StAXStreamWriter that writes to the provided
OutputStream using the platform default encoding. |
StAXStreamWriter(java.io.OutputStream stream,
java.lang.String encoding)
Constructs a
StAXStreamWriter that writes to the provided
OutputStream using the specified encoding. |
StAXStreamWriter(java.io.Writer writer)
Constructs a
StAXStreamWriter that writes to the provided
Writer . |
StAXStreamWriter(java.io.Writer writer,
NamespaceContext rootContext)
Constructs a
StAXStreamWriter that writes to the provided
Writer . |
Modifier and Type | Method and Description |
---|---|
void |
close() |
protected void |
closeElementContext()
Closes the current
ElementContext , writing any cached content and
making it read-only. |
void |
flush() |
java.lang.String |
getCurrentPath()
Returns the current position of the writer as a path of
QName strings. |
NamespaceContext |
getNamespaceContext() |
java.lang.String |
getPrefix(java.lang.String uri) |
java.lang.Object |
getProperty(java.lang.String name) |
void |
setDefaultNamespace(java.lang.String uri) |
void |
setNamespaceContext(NamespaceContext context) |
void |
setPrefix(java.lang.String prefix,
java.lang.String uri) |
void |
writeAttribute(QName name,
java.lang.String value) |
void |
writeAttribute(java.lang.String localName,
java.lang.String value) |
void |
writeAttribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value) |
void |
writeAttribute(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value) |
void |
writeCData(java.lang.String data) |
void |
writeCharacters(char[] text,
int start,
int len) |
void |
writeCharacters(java.lang.String text) |
void |
writeComment(java.lang.String data) |
void |
writeDefaultNamespace(java.lang.String namespaceURI) |
void |
writeDTD(java.lang.String dtd) |
void |
writeEmptyElement(java.lang.String localName) |
void |
writeEmptyElement(java.lang.String namespaceURI,
java.lang.String localName) |
void |
writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI) |
void |
writeEndDocument() |
void |
writeEndElement() |
void |
writeEntityRef(java.lang.String name) |
void |
writeNamespace(java.lang.String prefix,
java.lang.String namespaceURI) |
void |
writeProcessingInstruction(java.lang.String target) |
void |
writeProcessingInstruction(java.lang.String target,
java.lang.String data) |
void |
writeStartDocument() |
void |
writeStartDocument(java.lang.String version) |
void |
writeStartDocument(java.lang.String encoding,
java.lang.String version) |
void |
writeStartElement(java.lang.String localName) |
void |
writeStartElement(java.lang.String namespaceURI,
java.lang.String localName) |
void |
writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI) |
void |
writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI,
boolean isEmpty)
Core start tag output method called by all other
writeXXXElement
methods. |
public StAXStreamWriter(java.io.OutputStream stream)
StAXStreamWriter
that writes to the provided
OutputStream
using the platform default encoding.stream
- The destination stream.public StAXStreamWriter(java.io.OutputStream stream, java.lang.String encoding) throws java.io.UnsupportedEncodingException
StAXStreamWriter
that writes to the provided
OutputStream
using the specified encoding.stream
- The destination stream.encoding
- The output encoding.java.io.UnsupportedEncodingException
- If the encoding isn't supported.public StAXStreamWriter(java.io.Writer writer)
StAXStreamWriter
that writes to the provided
Writer
.writer
- The destination Writer
instance.public StAXStreamWriter(java.io.Writer writer, NamespaceContext rootContext)
StAXStreamWriter
that writes to the provided
Writer
.writer
- The destination Writer
instance.rootContext
- The root namespace context.public void close() throws XMLStreamException
close
in interface XMLStreamWriter
XMLStreamException
public void flush() throws XMLStreamException
flush
in interface XMLStreamWriter
XMLStreamException
public java.lang.String getPrefix(java.lang.String uri) throws XMLStreamException
getPrefix
in interface XMLStreamWriter
XMLStreamException
public java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
getProperty
in interface XMLStreamWriter
java.lang.IllegalArgumentException
public void writeStartDocument() throws XMLStreamException
writeStartDocument
in interface XMLStreamWriter
XMLStreamException
public void writeStartDocument(java.lang.String version) throws XMLStreamException
writeStartDocument
in interface XMLStreamWriter
XMLStreamException
public void writeStartDocument(java.lang.String encoding, java.lang.String version) throws XMLStreamException
writeStartDocument
in interface XMLStreamWriter
XMLStreamException
public void writeEndDocument() throws XMLStreamException
writeEndDocument
in interface XMLStreamWriter
XMLStreamException
public void writeCData(java.lang.String data) throws XMLStreamException
writeCData
in interface XMLStreamWriter
XMLStreamException
public void writeCharacters(char[] text, int start, int len) throws XMLStreamException
writeCharacters
in interface XMLStreamWriter
XMLStreamException
public void writeCharacters(java.lang.String text) throws XMLStreamException
writeCharacters
in interface XMLStreamWriter
XMLStreamException
public void writeComment(java.lang.String data) throws XMLStreamException
writeComment
in interface XMLStreamWriter
XMLStreamException
public void writeDTD(java.lang.String dtd) throws XMLStreamException
writeDTD
in interface XMLStreamWriter
XMLStreamException
public void writeEntityRef(java.lang.String name) throws XMLStreamException
writeEntityRef
in interface XMLStreamWriter
XMLStreamException
public void writeProcessingInstruction(java.lang.String target, java.lang.String data) throws XMLStreamException
writeProcessingInstruction
in interface XMLStreamWriter
XMLStreamException
public void writeProcessingInstruction(java.lang.String target) throws XMLStreamException
writeProcessingInstruction
in interface XMLStreamWriter
XMLStreamException
public NamespaceContext getNamespaceContext()
getNamespaceContext
in interface XMLStreamWriter
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException
setNamespaceContext
in interface XMLStreamWriter
XMLStreamException
public void setDefaultNamespace(java.lang.String uri) throws XMLStreamException
setDefaultNamespace
in interface XMLStreamWriter
XMLStreamException
public void setPrefix(java.lang.String prefix, java.lang.String uri) throws XMLStreamException
setPrefix
in interface XMLStreamWriter
XMLStreamException
public void writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI, boolean isEmpty) throws XMLStreamException
writeXXXElement
methods.prefix
- The tag prefix.localName
- The tag local name.namespaceURI
- The namespace URI of the prefix.isEmpty
- Whether the tag is empty.XMLStreamException
- If an error occurs writing the tag to the stream.public void writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws XMLStreamException
writeStartElement
in interface XMLStreamWriter
XMLStreamException
public void writeStartElement(java.lang.String namespaceURI, java.lang.String localName) throws XMLStreamException
writeStartElement
in interface XMLStreamWriter
XMLStreamException
public void writeStartElement(java.lang.String localName) throws XMLStreamException
writeStartElement
in interface XMLStreamWriter
XMLStreamException
public void writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws XMLStreamException
writeEmptyElement
in interface XMLStreamWriter
XMLStreamException
public void writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName) throws XMLStreamException
writeEmptyElement
in interface XMLStreamWriter
XMLStreamException
public void writeEmptyElement(java.lang.String localName) throws XMLStreamException
writeEmptyElement
in interface XMLStreamWriter
XMLStreamException
public void writeAttribute(QName name, java.lang.String value) throws XMLStreamException
XMLStreamException
public void writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws XMLStreamException
writeAttribute
in interface XMLStreamWriter
XMLStreamException
public void writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws XMLStreamException
writeAttribute
in interface XMLStreamWriter
XMLStreamException
public void writeAttribute(java.lang.String localName, java.lang.String value) throws XMLStreamException
writeAttribute
in interface XMLStreamWriter
XMLStreamException
public void writeDefaultNamespace(java.lang.String namespaceURI) throws XMLStreamException
writeDefaultNamespace
in interface XMLStreamWriter
XMLStreamException
public void writeNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws XMLStreamException
writeNamespace
in interface XMLStreamWriter
XMLStreamException
public void writeEndElement() throws XMLStreamException
writeEndElement
in interface XMLStreamWriter
XMLStreamException
public java.lang.String getCurrentPath()
QName
strings.protected void closeElementContext() throws XMLStreamException
ElementContext
, 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.XMLStreamException
- If an error occurs flushing any element content.