XmlWriter Class
- java.
lang. Object - com.
azure. xml. XmlWriter
- com.
Implements
public abstract class XmlWriter
implements AutoCloseable
Writes an XML encoded value to a stream.
Constructor Summary
| Constructor | Description |
|---|---|
| XmlWriter() |
Creates an instance of XmlWriter. |
Method Summary
Methods inherited from java.lang.Object
Constructor Details
XmlWriter
public XmlWriter()
Creates an instance of XmlWriter.
Method Details
close
public abstract void close()
Closes the XML stream.
During closing the implementation of XmlWriter must flush any un-flushed content.
Throws:
flush
public abstract XmlWriter flush()
Flushes any un-flushed content that has been written to the XmlWriter.
Returns:
Throws:
writeBinary
public final XmlWriter writeBinary(byte[] value)
Writes a binary value as a base64 string.
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String localName, byte[] value)
Writes a binary attribute as a base64 string (attribute="value").
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
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:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String localName, byte[] value)
Writes a binary element as a base64 string (value).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String namespaceUri, String localName, byte[] value)
Writes a binary element as a base64 string that has a prefix (value).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(boolean value)
Writes a boolean value.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(Boolean value)
Writes a nullable boolean value.
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, boolean value)
Writes a boolean attribute (attribute="true").
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, Boolean value)
Writes a nullable boolean attribute (attribute="false").
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Writes a boolean attribute that has a prefix (prefix:attribute="true").
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Writes a nullable boolean attribute that has a prefix (prefix:attribute="false").
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, boolean value)
Writes a boolean element (true).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, Boolean value)
Writes a nullable boolean element (true).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, boolean value)
Writes a boolean element that has a prefix (true).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, Boolean value)
Writes a nullable boolean element that has a prefix (true).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeCDataString
public abstract XmlWriter writeCDataString(String value)
Writes a CData value directly into an XML element (value).
This doesn't write the XML element start tag or end tag.
This API is a convenience over writeString(String value) for CData values, it is possible to use writeString(String value) instead of this API.
Parameters:
Returns:
Throws:
writeDouble
public final XmlWriter writeDouble(double value)
Writes a double value.
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String localName, double value)
Writes a double attribute (attribute="3.14").
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String namespaceUri, String localName, double value)
Writes a double attribute that has a prefix (prefix:attribute="3.14").
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String localName, double value)
Writes a double element (3.14).
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String namespaceUri, String localName, double value)
Writes a double element that has a prefix (3.14).
Parameters:
Returns:
Throws:
writeEndElement
public abstract XmlWriter writeEndElement()
Ends the current XML element by writing the closing tag (``).
This call will determine the XML element tag name and prefix, if there is one, to close the current XML element scope.
Returns:
Throws:
writeFloat
public final XmlWriter writeFloat(float value)
Writes a float value.
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String localName, float value)
Writes a float attribute (attribute="2.7").
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String namespaceUri, String localName, float value)
Writes a float attribute that has a prefix (prefix:attribute="2.7").
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String localName, float value)
Writes a float element (2.7).
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String namespaceUri, String localName, float value)
Writes a float element that has a prefix (2.7).
Parameters:
Returns:
Throws:
writeInt
public final XmlWriter writeInt(int value)
Writes an int value.
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String localName, int value)
Writes an int attribute (attribute="10").
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String namespaceUri, String localName, int value)
Writes an int attribute that has a prefix (prefix:attribute="10").
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String localName, int value)
Writes an int element (10).
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String namespaceUri, String localName, int value)
Writes an int element that has a prefix (10).
Parameters:
Returns:
Throws:
writeLong
public final XmlWriter writeLong(long value)
Writes a long value.
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String namespaceUri, String localName, long value)
Writes a long attribute that has a prefix (prefix:attribute="100000000000").
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String localName, long value)
Writes a long attribute (attribute="100000000000").
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String namespaceUri, String localName, long value)
Writes a long element that has a prefix (100000000000).
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String localName, long value)
Writes a long element (100000000000).
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespaceUri)
Writes a default XML namespace.
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespacePrefix, String namespaceUri)
Writes an XML namespace with a specified prefix.
If the namespacePrefix is null or xmlns calling this method is equivalent to writeNamespace(String namespaceUri).
Parameters:
Returns:
Throws:
writeNumber
public final XmlWriter writeNumber(Number value)
Writes a nullable number.
If value is null this is a no-op.
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String localName, Number value)
Writes a nullable number attribute (attribute="number").
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String namespaceUri, String localName, Number value)
Writes a nullable number attribute that has a prefix (prefix:attribute="number").
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String localName, Number value)
Writes a nullable number element (number).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String namespaceUri, String localName, Number value)
Writes a nullable number element that has a prefix (number).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeStartDocument
public final XmlWriter writeStartDocument()
Writes the XML document start (``).
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 version, String encoding) which allows for specifying those values.
Returns:
Throws:
writeStartDocument
public abstract XmlWriter writeStartDocument(String version, String encoding)
Writes the XML document start (``).
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:
Returns:
Throws:
writeStartElement
public final XmlWriter writeStartElement(String localName)
Begins an XML element start (``).
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:
Returns:
Throws:
writeStartElement
public abstract XmlWriter writeStartElement(String namespaceUri, String localName)
Begins an XML element start that has a prefix (``).
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 localName).
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public final XmlWriter writeStartSelfClosingElement(String localName)
Begins an XML element start that will be self-closing (``).
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:
Returns:
Throws:
writeStartSelfClosingElement
public abstract XmlWriter writeStartSelfClosingElement(String namespaceUri, String localName)
Begins an XML element start that has a prefix that will be self-closing (``).
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 localName).
Parameters:
Returns:
Throws:
writeString
public abstract XmlWriter writeString(String value)
Writes a value directly into an XML element (value).
This doesn't write the XML element start tag or end tag.
writeCDataString(String value) is a convenience API if an XML CData value needs to be written.
Parameters:
Returns:
Throws:
writeStringAttribute
public final XmlWriter writeStringAttribute(String localName, String value)
Writes a String attribute (attribute="value").
Parameters:
Returns:
Throws:
writeStringAttribute
public abstract XmlWriter writeStringAttribute(String namespaceUri, String localName, String value)
Writes a String attribute that has a prefix (prefix:attribute="value").
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String localName, String value)
Writes a string element (string).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String namespaceUri, String localName, String value)
Writes a string element that has a prefix (string).
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value)
Writes an XmlSerializable<T> object.
If the value is null this is a no-op.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value, String rootElementName)
Writes an XmlSerializable<T> object.
If the value is null this is a no-op.
If rootElementName is null this is the same as calling writeXml(XmlSerializable<?> value).
Parameters:
Returns:
Throws:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for