| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
XMLOutputFactory ofactory = …;
ByteArrayOutputStream bos = …;
XMLStreamWriter writer = ofactory.createXMLStreamWriter(bos);
Based on 9 examples
XMLOutputFactory factory = …;
OutputStream out = …;
XMLStreamWriter writer = factory.createXMLStreamWriter(out);
Based on 9 examples
XMLOutputFactory outputFactory = …;
StringWriter writer = …;
XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
Based on 8 examples
public interface XMLStreamWriter
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:
|
Method Summary | |
---|---|
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 |
Returns the current namespace context. |
String |
Gets the prefix the uri is bound to |
Object |
getProperty(String name) Get the value of a feature/property from the underlying implementation |
void |
Binds a URI to the default namespace This URI is bound in the scope of the current START_ELEMENT / END_ELEMENT pair. |
void |
setNamespaceContext(NamespaceContext context) Sets the current namespace context for prefix and uri bindings. |
void |
Sets the prefix the uri is bound to. |
void |
writeAttribute(String localName, String value) Writes an attribute to the output stream without a prefix. |
void |
writeAttribute(String namespaceURI, String localName, String value) Writes an attribute to the output stream |
void |
writeAttribute(String prefix, String namespaceURI, String localName, String value) Writes an attribute to the output stream |
void |
writeCData(String data) Writes a CData section |
void |
writeCharacters(char[] text, int start, int len) Write text to the output |
void |
writeCharacters(String text) Write text to the output |
void |
writeComment(String data) Writes an xml comment with the data enclosed |
void |
writeDefaultNamespace(String namespaceURI) Writes the default namespace to the stream |
void |
Write a DTD section. |
void |
writeEmptyElement(String localName) Writes an empty element tag to the output |
void |
writeEmptyElement(String namespaceURI, String localName) Writes an empty element tag to the output |
void |
writeEmptyElement(String prefix, String localName, String namespaceURI) Writes an empty element tag to the output |
void |
Closes any start tags and writes corresponding end tags. |
void |
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(String name) Writes an entity reference |
void |
writeNamespace(String prefix, 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(String target) Writes a processing instruction |
void |
writeProcessingInstruction(String target, String data) Writes a processing instruction |
void |
Write the XML Declaration. |
void |
writeStartDocument(String version) Write the XML Declaration. |
void |
writeStartDocument(String encoding, String version) Write the XML Declaration. |
void |
writeStartElement(String localName) Writes a start tag to the output. |
void |
writeStartElement(String namespaceURI, String localName) Writes a start tag to the output |
void |
writeStartElement(String prefix, String localName, String namespaceURI) Writes a start tag to the output |
Method Detail |
---|
public void close() throws XMLStreamException
XMLStreamException
public void flush() throws XMLStreamException
XMLStreamException
public NamespaceContext getNamespaceContext()
public String getPrefix(String uri) throws XMLStreamException
uri
XMLStreamException
public Object getProperty(String name) throws IllegalArgumentException
name
- The name of the property, may not be nullIllegalArgumentException
- if the property is not supportedpublic void setDefaultNamespace(String uri) throws XMLStreamException
uri
- the uri to bind to the default namespace, may be nullXMLStreamException
public void setNamespaceContext(NamespaceContext context) throws XMLStreamException
context
- the namespace context to use for this writer, may not be nullXMLStreamException
public void setPrefix(String prefix, 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
public void writeAttribute(String localName, String value) throws XMLStreamException
localName
- the local name of the attributevalue
- the value of the attributeXMLStreamException
public void writeAttribute(String namespaceURI, String localName, String value) throws XMLStreamException
namespaceURI
- the uri of the prefix for this attributelocalName
- the local name of the attributevalue
- the value of the attributeXMLStreamException
- if the namespace URI has not been bound to a prefix and
javax.xml.stream.isRepairingNamespaces has not been set to truepublic void writeAttribute(String prefix, String namespaceURI, String localName, 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 attributeXMLStreamException
- if the namespace URI has not been bound to a prefix and
javax.xml.stream.isRepairingNamespaces has not been set to truepublic void writeCData(String data) throws XMLStreamException
data
- the data contained in the CData Section, may not be nullXMLStreamException
public void 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
public void writeCharacters(String text) throws XMLStreamException
text
- the value to writeXMLStreamException
public void writeComment(String data) throws XMLStreamException
data
- the data contained in the comment, may be nullXMLStreamException
public void writeDefaultNamespace(String namespaceURI) throws XMLStreamException
namespaceURI
- the uri to bind the default namespace toXMLStreamException
public void writeDTD(String dtd) throws XMLStreamException
dtd
- the DTD to be writtenXMLStreamException
public void writeEmptyElement(String localName) throws XMLStreamException
localName
- local name of the tag, may not be nullXMLStreamException
public void writeEmptyElement(String namespaceURI, 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 truepublic void writeEmptyElement(String prefix, String localName, 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
public void writeEndDocument() throws XMLStreamException
XMLStreamException
public void writeEndElement() throws XMLStreamException
XMLStreamException
public void writeEntityRef(String name) throws XMLStreamException
name
- the name of the entityXMLStreamException
public void writeNamespace(String prefix, String namespaceURI) throws XMLStreamException
prefix
- the prefix to bind this namespace tonamespaceURI
- the uri to bind the prefix toXMLStreamException
public void writeProcessingInstruction(String target) throws XMLStreamException
target
- the target of the processing instruction, may not be nullXMLStreamException
public void writeProcessingInstruction(String target, 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
public void writeStartDocument() throws XMLStreamException
XMLStreamException
public void writeStartDocument(String version) throws XMLStreamException
version
- version of the xml documentXMLStreamException
public void writeStartDocument(String encoding, String version) throws XMLStreamException
encoding
- encoding of the xml declarationversion
- version of the xml documentXMLStreamException
- If given encoding does not match encoding
of the underlying streampublic void writeStartElement(String localName) throws XMLStreamException
localName
- local name of the tag, may not be nullXMLStreamException
public void writeStartElement(String namespaceURI, 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 truepublic void writeStartElement(String prefix, String localName, 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 prefix to, may not be nullXMLStreamException
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |