XmlWriter Classe
- java.
lang. Object - com.
azure. xml. XmlWriter
- com.
Implementações
public abstract class XmlWriter
implements AutoCloseable
Grava um valor codificado em XML em um fluxo.
Resumo do Construtor
Construtor | Description |
---|---|
XmlWriter() |
Cria uma instância de XmlWriter. |
Resumo do método
Modificador e tipo | Método e descrição |
---|---|
abstract void |
close()
Fecha o fluxo XML. |
abstract
Xml |
flush()
Libera qualquer conteúdo não liberado que tenha sido gravado no XmlWriter. |
final
Xml |
writeBinary(byte[] value)
Grava um valor binário como uma cadeia de caracteres base64. |
final
Xml |
writeBinaryAttribute(String localName, byte[] value)
Grava um atributo binário como uma cadeia de caracteres base64 ( |
final
Xml |
writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
Grava um atributo binário como uma cadeia de caracteres base64 que tem um prefixo ( |
final
Xml |
writeBinaryElement(String localName, byte[] value)
Grava um elemento binário como uma cadeia de caracteres base64 ( |
final
Xml |
writeBinaryElement(String namespaceUri, String localName, byte[] value)
Grava um elemento binário como uma cadeia de caracteres base64 que tem um prefixo ( |
final
Xml |
writeBoolean(boolean value)
Grava um valor booliano. |
final
Xml |
writeBoolean(Boolean value)
Grava um valor booliano anulável. |
final
Xml |
writeBooleanAttribute(String localName, boolean value)
Grava um atributo booliano ( |
final
Xml |
writeBooleanAttribute(String localName, Boolean value)
Grava um atributo booliano anulável ( |
final
Xml |
writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Grava um atributo booliano que tem um prefixo ( |
final
Xml |
writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Grava um atributo booliano anulável que tem um prefixo ( |
final
Xml |
writeBooleanElement(String localName, boolean value)
Grava um elemento booliano ( |
final
Xml |
writeBooleanElement(String localName, Boolean value)
Grava um elemento booliano anulável ( |
final
Xml |
writeBooleanElement(String namespaceUri, String localName, boolean value)
Grava um elemento booliano que tem um prefixo ( |
final
Xml |
writeBooleanElement(String namespaceUri, String localName, Boolean value)
Grava um elemento booliano anulável que tem um prefixo ( |
abstract
Xml |
writeCDataString(String value)
Grava um valor CData diretamente em um elemento XML ( |
final
Xml |
writeDouble(double value)
Grava um valor duplo. |
final
Xml |
writeDoubleAttribute(String localName, double value)
Grava um atributo duplo ( |
final
Xml |
writeDoubleAttribute(String namespaceUri, String localName, double value)
Grava um atributo duplo que tem um prefixo ( |
final
Xml |
writeDoubleElement(String localName, double value)
Grava um elemento duplo ( |
final
Xml |
writeDoubleElement(String namespaceUri, String localName, double value)
Grava um elemento duplo que tem um prefixo ( |
abstract
Xml |
writeEndElement()
Encerra o elemento XML atual gravando a marca de fechamento (''). |
final
Xml |
writeFloat(float value)
Grava um valor float. |
final
Xml |
writeFloatAttribute(String localName, float value)
Grava um atributo float ( |
final
Xml |
writeFloatAttribute(String namespaceUri, String localName, float value)
Grava um atributo float que tem um prefixo ( |
final
Xml |
writeFloatElement(String localName, float value)
Grava um elemento float ( |
final
Xml |
writeFloatElement(String namespaceUri, String localName, float value)
Grava um elemento float que tem um prefixo ( |
final
Xml |
writeInt(int value)
Grava um valor int. |
final
Xml |
writeIntAttribute(String localName, int value)
Grava um atributo int ( |
final
Xml |
writeIntAttribute(String namespaceUri, String localName, int value)
Grava um atributo int que tem um prefixo ( |
final
Xml |
writeIntElement(String localName, int value)
Grava um elemento int ( |
final
Xml |
writeIntElement(String namespaceUri, String localName, int value)
Grava um elemento int que tem um prefixo ( |
final
Xml |
writeLong(long value)
Grava um valor longo. |
final
Xml |
writeLongAttribute(String namespaceUri, String localName, long value)
Grava um atributo longo que tem um prefixo ( |
final
Xml |
writeLongAttribute(String localName, long value)
Grava um atributo longo ( |
final
Xml |
writeLongElement(String namespaceUri, String localName, long value)
Grava um elemento longo que tem um prefixo ( |
final
Xml |
writeLongElement(String localName, long value)
Grava um elemento long ( |
abstract
Xml |
writeNamespace(String namespaceUri)
Grava um namespace XML padrão. |
abstract
Xml |
writeNamespace(String namespacePrefix, String namespaceUri)
Grava um namespace XML com um prefixo especificado. |
final
Xml |
writeNumber(Number value)
Grava um número anulável. |
final
Xml |
writeNumberAttribute(String localName, Number value)
Grava um atributo numérico anulável ( |
final
Xml |
writeNumberAttribute(String namespaceUri, String localName, Number value)
Grava um atributo numérico anulável que tem um prefixo ( |
final
Xml |
writeNumberElement(String localName, Number value)
Grava um elemento numérico anulável ( |
final
Xml |
writeNumberElement(String namespaceUri, String localName, Number value)
Grava um elemento numérico anulável que tem um prefixo ( |
final
Xml |
writeStartDocument()
Grava o início do documento XML (''). |
abstract
Xml |
writeStartDocument(String version, String encoding)
Grava o início do documento XML (''). |
final
Xml |
writeStartElement(String localName)
Inicia um início de elemento XML (''). |
abstract
Xml |
writeStartElement(String namespaceUri, String localName)
Inicia um início de elemento XML que tem um prefixo (''). |
final
Xml |
writeStartSelfClosingElement(String localName)
Inicia um início de elemento XML que será de auto-fechamento (''). |
abstract
Xml |
writeStartSelfClosingElement(String namespaceUri, String localName)
Inicia um início de elemento XML que tem um prefixo que será o auto-fechamento (''). |
abstract
Xml |
writeString(String value)
Grava um valor diretamente em um elemento XML ( |
final
Xml |
writeStringAttribute(String localName, String value)
Grava um atributo String ( |
abstract
Xml |
writeStringAttribute(String namespaceUri, String localName, String value)
Grava um atributo String que tem um prefixo ( |
final
Xml |
writeStringElement(String localName, String value)
Grava um elemento de cadeia de caracteres ( |
final
Xml |
writeStringElement(String namespaceUri, String localName, String value)
Grava um elemento de cadeia de caracteres que tem um prefixo ( |
final
Xml |
writeXml(XmlSerializable<?> value)
Grava um XmlSerializable<T> objeto . |
final
Xml |
writeXml(XmlSerializable<?> value, String rootElementName)
Grava um XmlSerializable<T> objeto . |
Métodos herdados de java.lang.Object
Detalhes do construtor
XmlWriter
public XmlWriter()
Cria uma instância de XmlWriter.
Detalhes do método
close
public abstract void close()
Fecha o fluxo XML.
Durante o fechamento, a implementação de XmlWriter deve liberar qualquer conteúdo não liberado.
Throws:
flush
public abstract XmlWriter flush()
Libera qualquer conteúdo não liberado que tenha sido gravado no XmlWriter.
Returns:
Throws:
writeBinary
public final XmlWriter writeBinary(byte[] value)
Grava um valor binário como uma cadeia de caracteres base64.
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String localName, byte[] value)
Grava um atributo binário como uma cadeia de caracteres base64 (attribute="value"
).
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
Grava um atributo binário como uma cadeia de caracteres base64 que tem um prefixo (prefix:attribute="value"
).
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String localName, byte[] value)
Grava um elemento binário como uma cadeia de caracteres base64 (value
).
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String namespaceUri, String localName, byte[] value)
Grava um elemento binário como uma cadeia de caracteres base64 que tem um prefixo (value
).
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(boolean value)
Grava um valor booliano.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(Boolean value)
Grava um valor booliano anulável.
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, boolean value)
Grava um atributo booliano (attribute="true"
).
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, Boolean value)
Grava um atributo booliano anulável (attribute="false"
).
Se o value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Grava um atributo booliano que tem um prefixo (prefix:attribute="true"
).
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Grava um atributo booliano anulável que tem um prefixo (prefix:attribute="false"
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, boolean value)
Grava um elemento booliano (true
).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, Boolean value)
Grava um elemento booliano anulável (true
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, boolean value)
Grava um elemento booliano que tem um prefixo (true
).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, Boolean value)
Grava um elemento booliano anulável que tem um prefixo (true
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeCDataString
public abstract XmlWriter writeCDataString(String value)
Grava um valor CData diretamente em um elemento XML (value
).
Isso não grava a marca de início ou de término do elemento XML.
Essa API é uma conveniência writeString(String value) para valores CData, é possível usar writeString(String value) em vez dessa API.
Parameters:
Returns:
Throws:
writeDouble
public final XmlWriter writeDouble(double value)
Grava um valor duplo.
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String localName, double value)
Grava um atributo duplo (attribute="3.14"
).
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String namespaceUri, String localName, double value)
Grava um atributo duplo que tem um prefixo (prefix:attribute="3.14"
).
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String localName, double value)
Grava um elemento duplo (3.14
).
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String namespaceUri, String localName, double value)
Grava um elemento duplo que tem um prefixo (3.14
).
Parameters:
Returns:
Throws:
writeEndElement
public abstract XmlWriter writeEndElement()
Encerra o elemento XML atual gravando a marca de fechamento ('').
Essa chamada determinará o nome e o prefixo da marca do elemento XML, se houver um, para fechar o escopo do elemento XML atual.
Returns:
Throws:
writeFloat
public final XmlWriter writeFloat(float value)
Grava um valor float.
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String localName, float value)
Grava um atributo float (attribute="2.7"
).
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String namespaceUri, String localName, float value)
Grava um atributo float que tem um prefixo (prefix:attribute="2.7"
).
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String localName, float value)
Grava um elemento float (2.7
).
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String namespaceUri, String localName, float value)
Grava um elemento float que tem um prefixo (2.7
).
Parameters:
Returns:
Throws:
writeInt
public final XmlWriter writeInt(int value)
Grava um valor int.
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String localName, int value)
Grava um atributo int (attribute="10"
).
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String namespaceUri, String localName, int value)
Grava um atributo int que tem um prefixo (prefix:attribute="10"
).
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String localName, int value)
Grava um elemento int (10
).
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String namespaceUri, String localName, int value)
Grava um elemento int que tem um prefixo (10
).
Parameters:
Returns:
Throws:
writeLong
public final XmlWriter writeLong(long value)
Grava um valor longo.
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String namespaceUri, String localName, long value)
Grava um atributo longo que tem um prefixo (prefix:attribute="100000000000"
).
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String localName, long value)
Grava um atributo longo (attribute="100000000000"
).
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String namespaceUri, String localName, long value)
Grava um elemento longo que tem um prefixo (100000000000
).
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String localName, long value)
Grava um elemento long (100000000000
).
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespaceUri)
Grava um namespace XML padrão.
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespacePrefix, String namespaceUri)
Grava um namespace XML com um prefixo especificado.
Se o namespacePrefix
for nulo ou xmlns
chamar esse método será equivalente a writeNamespace(String namespaceUri).
Parameters:
Returns:
Throws:
writeNumber
public final XmlWriter writeNumber(Number value)
Grava um número anulável.
Se value
for nulo, isso será uma operação não operada.
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String localName, Number value)
Grava um atributo numérico anulável (attribute="number"
).
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String namespaceUri, String localName, Number value)
Grava um atributo numérico anulável que tem um prefixo (prefix:attribute="number"
).
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String localName, Number value)
Grava um elemento numérico anulável (number
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String namespaceUri, String localName, Number value)
Grava um elemento numérico anulável que tem um prefixo (number
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeStartDocument
public final XmlWriter writeStartDocument()
Grava o início do documento XML ('').
Isso usa a versão e a codificação padrão que são 1.0
e utf-8
respectivamente. Se uma versão ou codificação diferente for necessária, use writeStartDocument(String version, String encoding) o que permite especificar esses valores.
Returns:
Throws:
writeStartDocument
public abstract XmlWriter writeStartDocument(String version, String encoding)
Grava o início do documento XML ('').
encoding
E version
são opcionais e, se não forem passados, seus valores padrão serão usados. Para version
o padrão é 1.0
e para encoding
o padrão é utf-8
.
Parameters:
Returns:
Throws:
writeStartElement
public final XmlWriter writeStartElement(String localName)
Inicia um início de elemento XML ('').
Essa chamada não fecha (>
) o elemento XML é iniciado, mas, em vez disso, o adia até que uma chamada inicie outro elemento ou para gravar o corpo do elemento. Isso também requer uma chamada explícita para writeEndElement() para encerrar o corpo do elemento XML.
As chamadas para gravar atributos não fecharão o elemento XML.
Parameters:
Returns:
Throws:
writeStartElement
public abstract XmlWriter writeStartElement(String namespaceUri, String localName)
Inicia um início de elemento XML que tem um prefixo ('').
Essa chamada não fecha (>
) o elemento XML é iniciado, mas, em vez disso, o adia até que uma chamada inicie outro elemento ou para gravar o corpo do elemento. Isso também requer uma chamada explícita para writeEndElement() para encerrar o corpo do elemento XML.
As chamadas para gravar atributos não fecharão o elemento XML.
Se prefix
for nulo, isso se comportará da mesma forma que writeStartElement(String localName).
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public final XmlWriter writeStartSelfClosingElement(String localName)
Inicia um início de elemento XML que será de auto-fechamento ('').
Essa chamada não fecha (/>
) o início do elemento XML, mas o adia até que uma chamada inicie outro elemento. Se houver uma tentativa de gravar o corpo do elemento depois de iniciar um elemento de auto-fechamento, um IllegalStateException será lançado, pois os elementos de auto-fechamento não têm um corpo.
As chamadas para gravar atributos não fecharão o elemento XML.
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public abstract XmlWriter writeStartSelfClosingElement(String namespaceUri, String localName)
Inicia um início de elemento XML que tem um prefixo que será o auto-fechamento ('').
Essa chamada não fecha (/>
) o início do elemento XML, mas o adia até que uma chamada inicie outro elemento. Se houver uma tentativa de gravar o corpo do elemento depois de iniciar um elemento de auto-fechamento, um IllegalStateException será lançado, pois os elementos de auto-fechamento não têm um corpo.
As chamadas para gravar atributos não fecharão o elemento XML.
Se prefix
for nulo, isso se comportará da mesma forma que writeStartSelfClosingElement(String localName).
Parameters:
Returns:
Throws:
writeString
public abstract XmlWriter writeString(String value)
Grava um valor diretamente em um elemento XML (value
).
Isso não grava a marca de início ou de término do elemento XML.
writeCDataString(String value) será uma API de conveniência se um valor de CData XML precisar ser gravado.
Parameters:
Returns:
Throws:
writeStringAttribute
public final XmlWriter writeStringAttribute(String localName, String value)
Grava um atributo String (attribute="value"
).
Parameters:
Returns:
Throws:
writeStringAttribute
public abstract XmlWriter writeStringAttribute(String namespaceUri, String localName, String value)
Grava um atributo String que tem um prefixo (prefix:attribute="value"
).
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String localName, String value)
Grava um elemento de cadeia de caracteres (string
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String namespaceUri, String localName, String value)
Grava um elemento de cadeia de caracteres que tem um prefixo (string
).
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value)
Grava um XmlSerializable<T> objeto .
Se o value
for nulo, este será um no-op.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value, String rootElementName)
Grava um XmlSerializable<T> objeto .
Se o value
for nulo, este será um no-op.
Se rootElementName
for nulo, isso será o mesmo que chamar writeXml(XmlSerializable<?> value).
Parameters:
Returns:
Throws:
Aplica-se a
Azure SDK for Java