public interface XMLStreamWriter
false
it is a fatal error if an element
is written with namespace URI that has not been bound to a prefix.
If javax.xml.stream.isRepairingNamespaces is set to true
the XMLStreamWriter implementation
must write a prefix for each unbound URI that it encounters in the
current scope.XMLOutputFactory
,
XMLStreamReader
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.
|
java.lang.String |
getPrefix(java.lang.String uri)
Gets the prefix the uri is bound to
|
java.lang.Object |
getProperty(java.lang.String name)
Get the value of a feature/property from the underlying implementation
|
void |
setDefaultNamespace(java.lang.String uri)
Binds a URI to the default namespace
This URI is bound
in the scope of the current START_ELEMENT / END_ELEMENT pair.
|
void |
setPrefix(java.lang.String prefix,
java.lang.String uri)
Sets the prefix the uri is bound to.
|
void |
writeAttribute(java.lang.String localName,
java.lang.String value)
Writes an attribute to the output stream without
a prefix.
|
void |
writeAttribute(java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
Writes an attribute to the output stream
|
void |
writeAttribute(java.lang.String prefix,
java.lang.String namespaceURI,
java.lang.String localName,
java.lang.String value)
Writes an attribute to the output stream
|
void |
writeCData(java.lang.String data)
Writes a CData section
|
void |
writeCharacters(char[] text,
int start,
int len)
Write text to the output
|
void |
writeCharacters(java.lang.String text)
Write text to the output
|
void |
writeComment(java.lang.String data)
Writes an xml comment with the data enclosed
|
void |
writeDefaultNamespace(java.lang.String namespaceURI)
Writes the default namespace to the stream
|
void |
writeDTD(java.lang.String dtd)
Write a DTD section.
|
void |
writeEmptyElement(java.lang.String localName)
Writes an empty element tag to the output
|
void |
writeEmptyElement(java.lang.String namespaceURI,
java.lang.String localName)
Writes an empty element tag to the output
|
void |
writeEmptyElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
Writes an empty element tag to the output
|
void |
writeEndDocument()
Closes any start tags and writes corresponding end tags.
|
void |
writeEndElement()
Writes an end tag to the output relying on the internal
state of the writer to determine the prefix and local name
of the event.
|
void |
writeEntityRef(java.lang.String name)
Writes an entity reference
|
void |
writeNamespace(java.lang.String prefix,
java.lang.String namespaceURI)
Writes a namespace to the output stream
If the prefix argument to this method is the empty string,
"xmlns", or null this method will delegate to writeDefaultNamespace
|
void |
writeProcessingInstruction(java.lang.String target)
Writes a processing instruction
|
void |
writeProcessingInstruction(java.lang.String target,
java.lang.String data)
Writes a processing instruction
|
void |
writeStartDocument()
Write the XML Declaration.
|
void |
writeStartDocument(java.lang.String version)
Write the XML Declaration.
|
void |
writeStartDocument(java.lang.String encoding,
java.lang.String version)
Write the XML Declaration.
|
void |
writeStartElement(java.lang.String localName)
Writes a start tag to the output.
|
void |
writeStartElement(java.lang.String namespaceURI,
java.lang.String localName)
Writes a start tag to the output
|
void |
writeStartElement(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI)
Writes a start tag to the output
|
void writeStartElement(java.lang.String localName) throws XMLStreamException
localName
- local name of the tag, may not be nullXMLStreamException
void writeStartElement(java.lang.String namespaceURI, java.lang.String localName) throws XMLStreamException
namespaceURI
- the namespaceURI of the prefix to use, may not be nulllocalName
- local name of the tag, may not be nullXMLStreamException
- if the namespace URI has not been bound to a
prefix and javax.xml.stream.isRepairingNamespaces has not been set to true
void writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws XMLStreamException
localName
- local name of the tag, may not be nullprefix
- the prefix of the tag, may not be nullnamespaceURI
- the uri to bind the prefix to, may not be nullXMLStreamException
void writeEmptyElement(java.lang.String namespaceURI, java.lang.String localName) throws XMLStreamException
namespaceURI
- the uri to bind the tag to, may not be nulllocalName
- local name of the tag, may not be nullXMLStreamException
- if the namespace URI has not been bound to a
prefix and javax.xml.stream.isRepairingNamespaces has not been set to true
void writeEmptyElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI) throws XMLStreamException
prefix
- the prefix of the tag, may not be nulllocalName
- local name of the tag, may not be nullnamespaceURI
- the uri to bind the tag to, may not be nullXMLStreamException
void writeEmptyElement(java.lang.String localName) throws XMLStreamException
localName
- local name of the tag, may not be nullXMLStreamException
void writeEndElement() throws XMLStreamException
XMLStreamException
void writeEndDocument() throws XMLStreamException
XMLStreamException
void close() throws XMLStreamException
XMLStreamException
void flush() throws XMLStreamException
XMLStreamException
void writeAttribute(java.lang.String localName, java.lang.String value) throws XMLStreamException
localName
- the local name of the attributevalue
- the value of the attributejava.lang.IllegalStateException
- if the current state does not allow Attribute writingXMLStreamException
void writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws XMLStreamException
prefix
- the prefix for this attributenamespaceURI
- the uri of the prefix for this attributelocalName
- the local name of the attributevalue
- the value of the attributejava.lang.IllegalStateException
- if the current state does not allow Attribute writingXMLStreamException
- if the namespace URI has not been bound to a prefix and
javax.xml.stream.isRepairingNamespaces has not been set to true
void writeAttribute(java.lang.String namespaceURI, java.lang.String localName, java.lang.String value) throws XMLStreamException
namespaceURI
- the uri of the prefix for this attributelocalName
- the local name of the attributevalue
- the value of the attributejava.lang.IllegalStateException
- if the current state does not allow Attribute writingXMLStreamException
- if the namespace URI has not been bound to a prefix and
javax.xml.stream.isRepairingNamespaces has not been set to true
void writeNamespace(java.lang.String prefix, java.lang.String namespaceURI) throws XMLStreamException
prefix
- the prefix to bind this namespace tonamespaceURI
- the uri to bind the prefix tojava.lang.IllegalStateException
- if the current state does not allow Namespace writingXMLStreamException
void writeDefaultNamespace(java.lang.String namespaceURI) throws XMLStreamException
namespaceURI
- the uri to bind the default namespace tojava.lang.IllegalStateException
- if the current state does not allow Namespace writingXMLStreamException
void writeComment(java.lang.String data) throws XMLStreamException
data
- the data contained in the comment, may be nullXMLStreamException
void writeProcessingInstruction(java.lang.String target) throws XMLStreamException
target
- the target of the processing instruction, may not be nullXMLStreamException
void writeProcessingInstruction(java.lang.String target, java.lang.String data) throws XMLStreamException
target
- the target of the processing instruction, may not be nulldata
- the data contained in the processing instruction, may not be nullXMLStreamException
void writeCData(java.lang.String data) throws XMLStreamException
data
- the data contained in the CData Section, may not be nullXMLStreamException
java.lang.IllegalStateException
- if the current state does not allow writing
CDatavoid writeDTD(java.lang.String dtd) throws XMLStreamException
doctypedecl
production
from the XML 1.0 specification.dtd
- the DTD to be writtenXMLStreamException
java.lang.IllegalStateException
- if the current state does not allow writing
DTDvoid writeEntityRef(java.lang.String name) throws XMLStreamException
name
- the name of the entityXMLStreamException
java.lang.IllegalStateException
- if the current state does not allow writing
Entity referencesvoid writeStartDocument() throws XMLStreamException
XMLStreamException
java.lang.IllegalStateException
- if the current state does not allow writing
StartDocumentvoid writeStartDocument(java.lang.String version) throws XMLStreamException
version
- version of the xml documentXMLStreamException
void writeStartDocument(java.lang.String encoding, java.lang.String version) throws XMLStreamException
encoding
- encoding of the xml declarationversion
- version of the xml documentXMLStreamException
void writeCharacters(java.lang.String text) throws XMLStreamException
text
- the value to writeXMLStreamException
java.lang.IllegalStateException
- if the current state does not allow writing
character datavoid writeCharacters(char[] text, int start, int len) throws XMLStreamException
text
- the value to writestart
- the starting position in the arraylen
- the number of characters to writeXMLStreamException
java.lang.IllegalStateException
- if the current state does not allow writing
character datajava.lang.ArrayIndexOutOfBoundsException
- if start
is not a
valid index for text
java.lang.String getPrefix(java.lang.String uri) throws XMLStreamException
XMLStreamException
void setPrefix(java.lang.String prefix, java.lang.String uri) throws XMLStreamException
prefix
- the prefix to bind to the uri, may not be nulluri
- the uri to bind to the prefix, may be nullXMLStreamException
void setDefaultNamespace(java.lang.String uri) throws XMLStreamException
uri
- the uri to bind to the default namespace, may be nullXMLStreamException
java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
name
- The name of the property, may not be nulljava.lang.IllegalArgumentException
- if the property is not supportedjava.lang.NullPointerException
- if the name is nullCopyright © 2013, Oracle and/or its affiliates. All rights reserved.
Use is subject to License Terms. Your use of this web site or any of its contents or software indicates your agreement to be bound by these License Terms.