| javax.xml.stream.XMLStreamWriter
| XMLStreamWriter | | public interface XMLStreamWriter (Code) | | The XMLStreamWriter interface specifies how to write XML. The XMLStreamWriter does
not perform well formedness checking on its input. However
the writeCharacters method is required to escape & , < and >
For attribute values the writeAttribute method will escape the
above characters plus " to ensure that all character content
and attribute values are well formed.
Each NAMESPACE
and ATTRIBUTE must be individually written.
XML Namespaces, javax.xml.stream.isRepairingNamespaces and write method behaviour |
| Method |
isRepairingNamespaces == true |
isRepairingNamespaces == false |
|
namespaceURI bound |
namespaceURI unbound |
namespaceURI bound |
namespaceURI unbound |
writeAttribute(namespaceURI, localName, value) |
prefix:localName="value" [1]
|
xmlns:{generated}="namespaceURI" {generated}:localName="value"
|
prefix:localName="value" [1]
|
XMLStreamException
|
writeAttribute(prefix, namespaceURI, localName, value) |
bound to same prefix:
prefix:localName="value" [1]
bound to different prefix:
xmlns:{generated}="namespaceURI" {generated}:localName="value"
|
xmlns:prefix="namespaceURI" prefix:localName="value" [3]
|
bound to same prefix:
prefix:localName="value" [1][2]
bound to different prefix:
XMLStreamException[2]
|
xmlns:prefix="namespaceURI" prefix:localName="value" [2][5]
|
writeStartElement(namespaceURI, localName)
writeEmptyElement(namespaceURI, localName) |
<prefix:localName> [1]
|
<{generated}:localName xmlns:{generated}="namespaceURI">
|
<prefix:localName> [1]
|
XMLStreamException
|
writeStartElement(prefix, localName, namespaceURI)
writeEmptyElement(prefix, localName, namespaceURI) |
bound to same prefix:
<prefix:localName> [1]
bound to different prefix:
<{generated}:localName xmlns:{generated}="namespaceURI">
|
<prefix:localName xmlns:prefix="namespaceURI"> [4]
|
bound to same prefix:
<prefix:localName> [1]
bound to different prefix:
XMLStreamException
|
<prefix:localName>
|
Notes:
- [1] if namespaceURI == default Namespace URI, then no prefix is written
- [2] if prefix == "" || null && namespaceURI == "", then no prefix or Namespace declaration is generated or written
- [3] if prefix == "" || null, then a prefix is randomly generated
- [4] if prefix == "" || null, then it is treated as the default Namespace and no prefix is generated or written, an xmlns declaration is generated and written if the namespaceURI is unbound
- [5] if prefix == "" || null, then it is treated as an invalid attempt to define the default Namespace and an XMLStreamException is thrown
|
version:
1.0
author:
Copyright (c) 2003 by BEA Systems. All Rights Reserved.
See Also: XMLOutputFactory
See Also: XMLStreamReader
since:
1.6 |
| Method Summary | |
| public void | close()
Close this writer and free any resources associated with the
writer. | | public void | flush()
Write any cached data to the underlying output mechanism. | | public NamespaceContext | getNamespaceContext()
Returns the current namespace context. | | public String | getPrefix(String uri)
| | public Object | getProperty(java.lang.String name)
| | public void | setDefaultNamespace(String uri)
Binds a URI to the default namespace
This URI is bound
in the scope of the current START_ELEMENT / END_ELEMENT pair. | | public void | setNamespaceContext(NamespaceContext context)
Sets the current namespace context for prefix and uri bindings.
This context becomes the root namespace context for writing and
will replace the current root namespace context. | | public void | setPrefix(String prefix, String uri)
Sets the prefix the uri is bound to. | | public void | writeAttribute(String localName, String value)
Writes an attribute to the output stream without
a prefix. | | public void | writeAttribute(String prefix, String namespaceURI, String localName, String value)
| | public void | writeAttribute(String namespaceURI, String localName, String value)
| | public void | writeCData(String data)
| | public void | writeCharacters(String text)
| | public void | writeCharacters(char[] text, int start, int len)
| | public void | writeComment(String data)
| | public void | writeDTD(String dtd)
Write a DTD section. | | public void | writeDefaultNamespace(String namespaceURI)
| | public void | writeEmptyElement(String namespaceURI, String localName)
| | public void | writeEmptyElement(String prefix, String localName, String namespaceURI)
| | public void | writeEmptyElement(String localName)
| | public void | writeEndDocument()
Closes any start tags and writes corresponding end tags. | | public 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. | | public void | writeEntityRef(String name)
| | public void | writeNamespace(String prefix, String namespaceURI)
| | public void | writeProcessingInstruction(String target)
| | public void | writeProcessingInstruction(String target, String data)
| | public void | writeStartDocument()
Write the XML Declaration. | | public void | writeStartDocument(String version)
Write the XML Declaration. | | public void | writeStartDocument(String encoding, String version)
Write the XML Declaration. | | public void | writeStartElement(String localName)
Writes a start tag to the output. | | public void | writeStartElement(String namespaceURI, String localName)
| | public void | writeStartElement(String prefix, String localName, String namespaceURI)
|
| getNamespaceContext | | public NamespaceContext getNamespaceContext()(Code) | | Returns the current namespace context.
the current NamespaceContext |
| setDefaultNamespace | | public void setDefaultNamespace(String uri) throws XMLStreamException(Code) | | Binds a URI to the default namespace
This URI is bound
in the scope of the current START_ELEMENT / END_ELEMENT pair.
If this method is called before a START_ELEMENT has been written
the uri is bound in the root scope.
Parameters:
uri - the uri to bind to the default namespace, may be null
throws:
XMLStreamException - |
| setNamespaceContext | | public void setNamespaceContext(NamespaceContext context) throws XMLStreamException(Code) | | Sets the current namespace context for prefix and uri bindings.
This context becomes the root namespace context for writing and
will replace the current root namespace context. Subsequent calls
to setPrefix and setDefaultNamespace will bind namespaces using
the context passed to the method as the root context for resolving
namespaces. This method may only be called once at the start of
the document. It does not cause the namespaces to be declared.
If a namespace URI to prefix mapping is found in the namespace
context it is treated as declared and the prefix may be used
by the StreamWriter.
Parameters:
context - the namespace context to use for this writer, may not be null
throws:
XMLStreamException - |
| setPrefix | | public void setPrefix(String prefix, String uri) throws XMLStreamException(Code) | | Sets the prefix the uri is bound to. This prefix is bound
in the scope of the current START_ELEMENT / END_ELEMENT pair.
If this method is called before a START_ELEMENT has been written
the prefix is bound in the root scope.
Parameters:
prefix - the prefix to bind to the uri, may not be null
Parameters:
uri - the uri to bind to the prefix, may be null
throws:
XMLStreamException - |
| writeAttribute | | public void writeAttribute(String localName, String value) throws XMLStreamException(Code) | | Writes an attribute to the output stream without
a prefix.
Parameters:
localName - the local name of the attribute
Parameters:
value - the value of the attribute
throws:
IllegalStateException - if the current state does not allow Attribute writing
throws:
XMLStreamException - |
| writeAttribute | | public void writeAttribute(String prefix, String namespaceURI, String localName, String value) throws XMLStreamException(Code) | | Writes an attribute to the output stream
Parameters:
prefix - the prefix for this attribute
Parameters:
namespaceURI - the uri of the prefix for this attribute
Parameters:
localName - the local name of the attribute
Parameters:
value - the value of the attribute
throws:
IllegalStateException - if the current state does not allow Attribute writing
throws:
XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isRepairingNamespaces has not been set to true |
| writeAttribute | | public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException(Code) | | Writes an attribute to the output stream
Parameters:
namespaceURI - the uri of the prefix for this attribute
Parameters:
localName - the local name of the attribute
Parameters:
value - the value of the attribute
throws:
IllegalStateException - if the current state does not allow Attribute writing
throws:
XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isRepairingNamespaces has not been set to true |
| writeCharacters | | public void writeCharacters(char[] text, int start, int len) throws XMLStreamException(Code) | | Write text to the output
Parameters:
text - the value to write
Parameters:
start - the starting position in the array
Parameters:
len - the number of characters to write
throws:
XMLStreamException - |
| writeDTD | | public void writeDTD(String dtd) throws XMLStreamException(Code) | | 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:
XMLStreamException - |
| writeEmptyElement | | public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException(Code) | | Writes an empty element tag to the output
Parameters:
namespaceURI - the uri to bind the tag to, may not be null
Parameters:
localName - local name of the tag, may not be null
throws:
XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isRepairingNamespaces has not been set to true |
| writeEmptyElement | | public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException(Code) | | Writes an empty element tag to the output
Parameters:
prefix - the prefix of the tag, may not be null
Parameters:
localName - local name of the tag, may not be null
Parameters:
namespaceURI - the uri to bind the tag to, may not be null
throws:
XMLStreamException - |
| writeEndElement | | public void writeEndElement() throws XMLStreamException(Code) | | 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.
throws:
XMLStreamException - |
| writeNamespace | | public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException(Code) | | 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
Parameters:
prefix - the prefix to bind this namespace to
Parameters:
namespaceURI - the uri to bind the prefix to
throws:
IllegalStateException - if the current state does not allow Namespace writing
throws:
XMLStreamException - |
| writeProcessingInstruction | | public void writeProcessingInstruction(String target) throws XMLStreamException(Code) | | Writes a processing instruction
Parameters:
target - the target of the processing instruction, may not be null
throws:
XMLStreamException - |
| writeProcessingInstruction | | public void writeProcessingInstruction(String target, String data) throws XMLStreamException(Code) | | Writes a processing instruction
Parameters:
target - the target of the processing instruction, may not be null
Parameters:
data - the data contained in the processing instruction, may not be null
throws:
XMLStreamException - |
| writeStartDocument | | public void writeStartDocument(String encoding, String version) throws XMLStreamException(Code) | | Write the XML Declaration. Note that the encoding parameter does
not set the actual encoding of the underlying output. That must
be set when the instance of the XMLStreamWriter is created using the
XMLOutputFactory
Parameters:
encoding - encoding of the xml declaration
Parameters:
version - version of the xml document
throws:
XMLStreamException - If given encoding does not match encoding of the underlying stream |
| writeStartElement | | public void writeStartElement(String localName) throws XMLStreamException(Code) | | Writes a start tag to the output. All writeStartElement methods
open a new scope in the internal namespace context. Writing the
corresponding EndElement causes the scope to be closed.
Parameters:
localName - local name of the tag, may not be null
throws:
XMLStreamException - |
| writeStartElement | | public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException(Code) | | Writes a start tag to the output
Parameters:
namespaceURI - the namespaceURI of the prefix to use, may not be null
Parameters:
localName - local name of the tag, may not be null
throws:
XMLStreamException - if the namespace URI has not been bound to a prefix andjavax.xml.stream.isRepairingNamespaces has not been set to true |
| writeStartElement | | public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException(Code) | | Writes a start tag to the output
Parameters:
localName - local name of the tag, may not be null
Parameters:
prefix - the prefix of the tag, may not be null
Parameters:
namespaceURI - the uri to bind the prefix to, may not be null
throws:
XMLStreamException - |
|
|