Package com.azure.xml

Class XmlWriter

java.lang.Object
com.azure.xml.XmlWriter
All Implemented Interfaces:
AutoCloseable
public final class XmlWriter extends Object implements AutoCloseable
Writes an XML encoded value to a stream.

  • Method Details

    • toStream

      public static XmlWriter toStream(OutputStream xml) throws XMLStreamException
      Creates an instance of XmlWriter that writes to the provided OutputStream.

      This uses the XMLStreamWriter implementation provided by the default XMLOutputFactory.newInstance(). If you need to provide a custom implementation of XMLStreamWriter use fromXmlStreamWriter(XMLStreamWriter).

      Parameters:
      xml - The OutputStream where content will be written.
      Returns:
      A new instance of XmlWriter.
      Throws:
      NullPointerException - If xml is null.
      XMLStreamException - If an XmlWriter cannot be instantiated.

    • toWriter

      public static XmlWriter toWriter(Writer xml) throws XMLStreamException
      Creates an instance of XmlWriter that writes to the provided Writer.

      This uses the XMLStreamWriter implementation provided by the default XMLOutputFactory.newInstance(). If you need to provide a custom implementation of XMLStreamWriter use fromXmlStreamWriter(XMLStreamWriter).

      Parameters:
      xml - The Writer where content will be written.
      Returns:
      A new instance of XmlWriter.
      Throws:
      NullPointerException - If xml is null.
      XMLStreamException - If an XmlWriter cannot be instantiated.

    • fromXmlStreamWriter

      public static XmlWriter fromXmlStreamWriter(XMLStreamWriter writer)
      Creates an instance of XmlWriter that writes to the provided XMLStreamWriter.
      Parameters:
      writer - The XMLStreamWriter where content will be written.
      Returns:
      A new instance of XmlWriter.
      Throws:
      NullPointerException - If writer is null.

    • writeStartDocument

      public XmlWriter writeStartDocument() throws XMLStreamException
      Writes the XML document start (<?xml version="1.0" encoding="UTF-8">).

      This uses the default version and encoding which are 1.0 and UTF-8 respectively. If a different version or encoding is required use writeStartDocument(String, String) which allows for specifying those values.

      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML start document cannot be written.

    • writeStartDocument

      public XmlWriter writeStartDocument(String version, String encoding) throws XMLStreamException
      Writes the XML document start (<?xml version="1.0" encoding="utf-8">).

      Both version and encoding are optional and if they aren't passed their default values will be used. For version the default is 1.0 and for encoding the default is UTF-8.

      Parameters:
      version - XML document version.
      encoding - XML document encoding.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML start document cannot be written.

    • writeStartElement

      public XmlWriter writeStartElement(String localName) throws XMLStreamException
      Begins an XML element start (<tag).

      This call doesn't close (>) the XML element start but instead defers it until a call to begin another element or to write the body of the element. This also requires an explicit call to writeEndElement() to end the XML element's body.

      Calls to write attributes won't close the XML element.

      Parameters:
      localName - Name of the element.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element start cannot be written.

    • writeStartElement

      public XmlWriter writeStartElement(String namespaceUri, String localName) throws XMLStreamException
      Begins an XML element start that has a prefix (<prefix:tag).

      This call doesn't close (>) the XML element start but instead defers it until a call to begin another element or to write the body of the element. This also requires an explicit call to writeEndElement() to end the XML element's body.

      Calls to write attributes won't close the XML element.

      If prefix is null this will behave the same as writeStartElement(String).

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element start cannot be written.

    • writeStartSelfClosingElement

      public XmlWriter writeStartSelfClosingElement(String localName) throws XMLStreamException
      Begins an XML element start that will be self-closing (<tag/>).

      This call doesn't close (/>) the XML element start but instead defers it until a call to begin another element. If there is an attempt to write the body of the element after beginning a self-closing element an IllegalStateException will be thrown as self-closing elements do not have a body.

      Calls to write attributes won't close the XML element.

      Parameters:
      localName - Name of the element.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element start cannot be written.

    • writeStartSelfClosingElement

      public XmlWriter writeStartSelfClosingElement(String namespaceUri, String localName) throws XMLStreamException
      Begins an XML element start that has a prefix that will be self-closing (<prefix:tag/>).

      This call doesn't close (/>) the XML element start but instead defers it until a call to begin another element. If there is an attempt to write the body of the element after beginning a self-closing element an IllegalStateException will be thrown as self-closing elements do not have a body.

      Calls to write attributes won't close the XML element.

      If prefix is null this will behave the same as writeStartSelfClosingElement(String).

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element start cannot be written.

    • writeEndElement

      public XmlWriter writeEndElement() throws XMLStreamException
      Ends the current XML element by writing the closing tag (</tag>).

      This call will determine the XML element tag name and prefix, if there is one, to close the current XML element scope.

      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element end cannot be written.

    • writeNamespace

      public XmlWriter writeNamespace(String namespaceUri) throws XMLStreamException
      Writes a default XML namespace.
      Parameters:
      namespaceUri - Namespace URI to bind as the default namespace.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML namespace cannot be written.

    • writeNamespace

      public XmlWriter writeNamespace(String namespacePrefix, String namespaceUri) throws XMLStreamException
      Writes an XML namespace with a specified prefix.

      If the namespacePrefix is null or xmlns calling this method is equivalent to writeNamespace(String).

      Parameters:
      namespacePrefix - Prefix that the namespace binds.
      namespaceUri - Namespace URI to bind to the prefix.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML namespace cannot be written.

    • writeStringAttribute

      public XmlWriter writeStringAttribute(String localName, String value) throws XMLStreamException
      Writes a String attribute (attribute="value").
      Parameters:
      localName - Name of the attribute.
      value - Value of the attribute.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeStringAttribute

      public XmlWriter writeStringAttribute(String namespaceUri, String localName, String value) throws XMLStreamException
      Writes a String attribute that has a prefix (prefix:attribute="value").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - Value of the attribute.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBinaryAttribute

      public XmlWriter writeBinaryAttribute(String localName, byte[] value) throws XMLStreamException
      Writes a binary attribute as a base64 string (attribute="value").

      If the value is null this is a no-op.

      Parameters:
      localName - Name of the attribute.
      value - Binary value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBinaryAttribute

      public XmlWriter writeBinaryAttribute(String namespaceUri, String localName, byte[] value) throws XMLStreamException
      Writes a binary attribute as a base64 string that has a prefix (prefix:attribute="value").

      If the value is null this is a no-op.

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - Binary value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBooleanAttribute

      public XmlWriter writeBooleanAttribute(String localName, boolean value) throws XMLStreamException
      Writes a boolean attribute (attribute="true").
      Parameters:
      localName - Name of the attribute.
      value - boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBooleanAttribute

      public XmlWriter writeBooleanAttribute(String namespaceUri, String localName, boolean value) throws XMLStreamException
      Writes a boolean attribute that has a prefix (prefix:attribute="true").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBooleanAttribute

      public XmlWriter writeBooleanAttribute(String localName, Boolean value) throws XMLStreamException
      Writes a nullable boolean attribute (attribute="false").

      If the value is null this is a no-op.

      Parameters:
      localName - Name of the attribute.
      value - Boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBooleanAttribute

      public XmlWriter writeBooleanAttribute(String namespaceUri, String localName, Boolean value) throws XMLStreamException
      Writes a nullable boolean attribute that has a prefix (prefix:attribute="false").

      If the value is null this is a no-op.

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - Boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeDoubleAttribute

      public XmlWriter writeDoubleAttribute(String localName, double value) throws XMLStreamException
      Writes a double attribute (attribute="3.14").
      Parameters:
      localName - Name of the attribute.
      value - double value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeDoubleAttribute

      public XmlWriter writeDoubleAttribute(String namespaceUri, String localName, double value) throws XMLStreamException
      Writes a double attribute that has a prefix (prefix:attribute="3.14").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - double value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeFloatAttribute

      public XmlWriter writeFloatAttribute(String localName, float value) throws XMLStreamException
      Writes a float attribute (attribute="2.7").
      Parameters:
      localName - Name of the attribute.
      value - float value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeFloatAttribute

      public XmlWriter writeFloatAttribute(String namespaceUri, String localName, float value) throws XMLStreamException
      Writes a float attribute that has a prefix (prefix:attribute="2.7").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - float value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeIntAttribute

      public XmlWriter writeIntAttribute(String localName, int value) throws XMLStreamException
      Writes an int attribute (attribute="10").
      Parameters:
      localName - Name of the attribute.
      value - int value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeIntAttribute

      public XmlWriter writeIntAttribute(String namespaceUri, String localName, int value) throws XMLStreamException
      Writes an int attribute that has a prefix (prefix:attribute="10").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - int value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeLongAttribute

      public XmlWriter writeLongAttribute(String localName, long value) throws XMLStreamException
      Writes a long attribute (attribute="100000000000").
      Parameters:
      localName - Name of the attribute.
      value - long value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeLongAttribute

      public XmlWriter writeLongAttribute(String namespaceUri, String localName, long value) throws XMLStreamException
      Writes a long attribute that has a prefix (prefix:attribute="100000000000").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - long value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeNumberAttribute

      public XmlWriter writeNumberAttribute(String localName, Number value) throws XMLStreamException
      Writes a nullable number attribute (attribute="number").
      Parameters:
      localName - Name of the attribute.
      value - Number value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeNumberAttribute

      public XmlWriter writeNumberAttribute(String namespaceUri, String localName, Number value) throws XMLStreamException
      Writes a nullable number attribute that has a prefix (prefix:attribute="number").
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the attribute.
      value - Number value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML attribute cannot be written.

    • writeBinaryElement

      public XmlWriter writeBinaryElement(String localName, byte[] value) throws XMLStreamException
      Writes a binary element as a base64 string (<tag>value</tag).

      If the value is null this is a no-op.

      Parameters:
      localName - Name of the element.
      value - Binary value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeBinaryElement

      public XmlWriter writeBinaryElement(String namespaceUri, String localName, byte[] value) throws XMLStreamException
      Writes a binary element as a base64 string that has a prefix (<tag>value</tag).

      If the value is null this is a no-op.

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - Binary value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeBooleanElement

      public XmlWriter writeBooleanElement(String localName, boolean value) throws XMLStreamException
      Writes a boolean element (<tag>true</tag).
      Parameters:
      localName - Name of the element.
      value - boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeBooleanElement

      public XmlWriter writeBooleanElement(String namespaceUri, String localName, boolean value) throws XMLStreamException
      Writes a boolean element that has a prefix (<tag>true</tag).
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeBooleanElement

      public XmlWriter writeBooleanElement(String localName, Boolean value) throws XMLStreamException
      Writes a nullable boolean element (<tag>true</tag).

      If the value is null this is a no-op.

      Parameters:
      localName - Name of the element.
      value - Boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeBooleanElement

      public XmlWriter writeBooleanElement(String namespaceUri, String localName, Boolean value) throws XMLStreamException
      Writes a nullable boolean element that has a prefix (<tag>true</tag).

      If the value is null this is a no-op.

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - Boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeDoubleElement

      public XmlWriter writeDoubleElement(String localName, double value) throws XMLStreamException
      Writes a double element (<tag>3.14</tag).
      Parameters:
      localName - Name of the element.
      value - double value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeDoubleElement

      public XmlWriter writeDoubleElement(String namespaceUri, String localName, double value) throws XMLStreamException
      Writes a double element that has a prefix (<tag>3.14</tag).
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - double value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeFloatElement

      public XmlWriter writeFloatElement(String localName, float value) throws XMLStreamException
      Writes a float element (<tag>2.7</tag).
      Parameters:
      localName - Name of the element.
      value - float value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeFloatElement

      public XmlWriter writeFloatElement(String namespaceUri, String localName, float value) throws XMLStreamException
      Writes a float element that has a prefix (<tag>2.7</tag).
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - float value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeIntElement

      public XmlWriter writeIntElement(String localName, int value) throws XMLStreamException
      Writes an int element (<tag>10</tag).
      Parameters:
      localName - Name of the element.
      value - int value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeIntElement

      public XmlWriter writeIntElement(String namespaceUri, String localName, int value) throws XMLStreamException
      Writes an int element that has a prefix (<tag>10</tag).
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - int value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeLongElement

      public XmlWriter writeLongElement(String localName, long value) throws XMLStreamException
      Writes a long element (<tag>100000000000</tag).
      Parameters:
      localName - Name of the element
      value - long value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeLongElement

      public XmlWriter writeLongElement(String namespaceUri, String localName, long value) throws XMLStreamException
      Writes a long element that has a prefix (<tag>100000000000</tag).
      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - long value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeNumberElement

      public XmlWriter writeNumberElement(String localName, Number value) throws XMLStreamException
      Writes a nullable number element (<tag>number</tag).

      If the value is null this is a no-op.

      Parameters:
      localName - Name of the element.
      value - Number value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeNumberElement

      public XmlWriter writeNumberElement(String namespaceUri, String localName, Number value) throws XMLStreamException
      Writes a nullable number element that has a prefix (<tag>number</tag).

      If the value is null this is a no-op.

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - Number value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeStringElement

      public XmlWriter writeStringElement(String localName, String value) throws XMLStreamException
      Writes a string element (<tag>string</tag).

      If the value is null this is a no-op.

      Parameters:
      localName - Name of the element.
      value - String value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeStringElement

      public XmlWriter writeStringElement(String namespaceUri, String localName, String value) throws XMLStreamException
      Writes a string element that has a prefix (<tag>string</tag).

      If the value is null this is a no-op.

      Parameters:
      namespaceUri - Namespace URI to bind the prefix to, if null the default namespace is used.
      localName - Name of the element.
      value - String value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML element and value cannot be written.

    • writeXml

      public XmlWriter writeXml(XmlSerializable<?> value) throws XMLStreamException
      Writes an XmlSerializable object.

      If the value is null this is a no-op.

      Parameters:
      value - XmlSerializable object to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML object cannot be written.

    • writeXml

      public XmlWriter writeXml(XmlSerializable<?> value, String rootElementName) throws XMLStreamException
      Writes an XmlSerializable object.

      If the value is null this is a no-op.

      If rootElementName is null this is the same as calling writeXml(XmlSerializable).

      Parameters:
      value - XmlSerializable object to write.
      rootElementName - Override of the XML element name defined by the object.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML object cannot be written.

    • writeBinary

      public XmlWriter writeBinary(byte[] value) throws XMLStreamException
      Writes a binary value as a base64 string.

      If the value is null this is a no-op.

      Parameters:
      value - Binary value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeBoolean

      public XmlWriter writeBoolean(boolean value) throws XMLStreamException
      Writes a boolean value.
      Parameters:
      value - boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeBoolean

      public XmlWriter writeBoolean(Boolean value) throws XMLStreamException
      Writes a nullable boolean value.

      If the value is null this is a no-op.

      Parameters:
      value - Boolean value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeDouble

      public XmlWriter writeDouble(double value) throws XMLStreamException
      Writes a double value.
      Parameters:
      value - double value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeFloat

      public XmlWriter writeFloat(float value) throws XMLStreamException
      Writes a float value.
      Parameters:
      value - float value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeInt

      public XmlWriter writeInt(int value) throws XMLStreamException
      Writes an int value.
      Parameters:
      value - int value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeLong

      public XmlWriter writeLong(long value) throws XMLStreamException
      Writes a long value.
      Parameters:
      value - long value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeNumber

      public XmlWriter writeNumber(Number value) throws XMLStreamException
      Writes a nullable number.

      If value is null this is a no-op.

      Parameters:
      value - Number value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeString

      public XmlWriter writeString(String value) throws XMLStreamException
      Writes a value directly into an XML element (<tag>value</tag>).

      This doesn't write the XML element start tag or end tag.

      writeCDataString(String) is a convenience API if an XML CData value needs to be written.

      Parameters:
      value - Value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML value cannot be written.

    • writeCDataString

      public XmlWriter writeCDataString(String value) throws XMLStreamException
      Writes a CData value directly into an XML element (<tag><![CDATA[value]]></tag>).

      This doesn't write the XML element start tag or end tag.

      This API is a convenience over writeString(String) for CData values, it is possible to use writeString(String) instead of this API.

      Parameters:
      value - CData value to write.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the XML CData value cannot be written.

    • flush

      public XmlWriter flush() throws XMLStreamException
      Flushes any un-flushed content that has been written to the XmlWriter.
      Returns:
      The updated XmlWriter object.
      Throws:
      XMLStreamException - If the un-flushed XML content could not be flushed.

    • close

      public void close() throws XMLStreamException
      Closes the XML stream.

      During closing the implementation of XmlWriter must flush any un-flushed content.

      Specified by:
      close in interface AutoCloseable
      Throws:
      XMLStreamException - If the underlying content store fails to close.