XmlWriter Clase
- java.
lang. Object - com.
azure. xml. XmlWriter
- com.
Implementaciones
public abstract class XmlWriter
implements AutoCloseable
Escribe un valor codificado XML en una secuencia.
Resumen del constructor
| Constructor | Description |
|---|---|
| XmlWriter() |
Crea una instancia de XmlWriter. |
Resumen del método
| Modificador y tipo | Método y descripción |
|---|---|
| abstract void |
close()
Cierra la secuencia XML. |
|
abstract
Xml |
flush()
Vacía cualquier contenido sin vaciar que se haya escrito en .XmlWriter |
|
final
Xml |
writeBinary(byte[] value)
Escribe un valor binario como una cadena base64. |
|
final
Xml |
writeBinaryAttribute(String localName, byte[] value)
Escribe un atributo binario como una cadena base64 ( |
|
final
Xml |
writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
Escribe un atributo binario como una cadena base64 que tiene un prefijo ( |
|
final
Xml |
writeBinaryElement(String localName, byte[] value)
Escribe un elemento binario como una cadena base64 ( |
|
final
Xml |
writeBinaryElement(String namespaceUri, String localName, byte[] value)
Escribe un elemento binario como una cadena base64 que tiene un prefijo ( |
|
final
Xml |
writeBoolean(boolean value)
Escribe un valor booleano. |
|
final
Xml |
writeBoolean(Boolean value)
Escribe un valor booleano que acepta valores NULL. |
|
final
Xml |
writeBooleanAttribute(String localName, boolean value)
Escribe un atributo booleano ( |
|
final
Xml |
writeBooleanAttribute(String localName, Boolean value)
Escribe un atributo booleano que acepta valores NULL ( |
|
final
Xml |
writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Escribe un atributo booleano que tiene un prefijo ( |
|
final
Xml |
writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Escribe un atributo booleano que acepta valores NULL que tiene un prefijo ( |
|
final
Xml |
writeBooleanElement(String localName, boolean value)
Escribe un elemento booleano ( |
|
final
Xml |
writeBooleanElement(String localName, Boolean value)
Escribe un elemento booleano que acepta valores NULL ( |
|
final
Xml |
writeBooleanElement(String namespaceUri, String localName, boolean value)
Escribe un elemento booleano que tiene un prefijo ( |
|
final
Xml |
writeBooleanElement(String namespaceUri, String localName, Boolean value)
Escribe un elemento booleano que acepta valores NULL que tiene un prefijo ( |
|
abstract
Xml |
writeCDataString(String value)
Escribe un valor de CData directamente en un elemento XML ( |
|
final
Xml |
writeDouble(double value)
Escribe un valor doble. |
|
final
Xml |
writeDoubleAttribute(String localName, double value)
Escribe un atributo double ( |
|
final
Xml |
writeDoubleAttribute(String namespaceUri, String localName, double value)
Escribe un atributo double que tiene un prefijo ( |
|
final
Xml |
writeDoubleElement(String localName, double value)
Escribe un elemento double ( |
|
final
Xml |
writeDoubleElement(String namespaceUri, String localName, double value)
Escribe un elemento double que tiene un prefijo ( |
|
abstract
Xml |
writeEndElement()
Finaliza el elemento XML actual escribiendo la etiqueta de cierre (''). |
|
final
Xml |
writeFloat(float value)
Escribe un valor float. |
|
final
Xml |
writeFloatAttribute(String localName, float value)
Escribe un atributo float ( |
|
final
Xml |
writeFloatAttribute(String namespaceUri, String localName, float value)
Escribe un atributo float que tiene un prefijo ( |
|
final
Xml |
writeFloatElement(String localName, float value)
Escribe un elemento float ( |
|
final
Xml |
writeFloatElement(String namespaceUri, String localName, float value)
Escribe un elemento float que tiene un prefijo ( |
|
final
Xml |
writeInt(int value)
Escribe un valor int. |
|
final
Xml |
writeIntAttribute(String localName, int value)
Escribe un atributo int ( |
|
final
Xml |
writeIntAttribute(String namespaceUri, String localName, int value)
Escribe un atributo int que tiene un prefijo ( |
|
final
Xml |
writeIntElement(String localName, int value)
Escribe un elemento int ( |
|
final
Xml |
writeIntElement(String namespaceUri, String localName, int value)
Escribe un elemento int que tiene un prefijo ( |
|
final
Xml |
writeLong(long value)
Escribe un valor largo. |
|
final
Xml |
writeLongAttribute(String namespaceUri, String localName, long value)
Escribe un atributo long que tiene un prefijo ( |
|
final
Xml |
writeLongAttribute(String localName, long value)
Escribe un atributo long ( |
|
final
Xml |
writeLongElement(String namespaceUri, String localName, long value)
Escribe un elemento long que tiene un prefijo ( |
|
final
Xml |
writeLongElement(String localName, long value)
Escribe un elemento long ( |
|
abstract
Xml |
writeNamespace(String namespaceUri)
Escribe un espacio de nombres XML predeterminado. |
|
abstract
Xml |
writeNamespace(String namespacePrefix, String namespaceUri)
Escribe un espacio de nombres XML con un prefijo especificado. |
|
final
Xml |
writeNumber(Number value)
Escribe un número que acepta valores NULL. |
|
final
Xml |
writeNumberAttribute(String localName, Number value)
Escribe un atributo numérico que acepta valores NULL ( |
|
final
Xml |
writeNumberAttribute(String namespaceUri, String localName, Number value)
Escribe un atributo numérico que acepta valores NULL que tiene un prefijo ( |
|
final
Xml |
writeNumberElement(String localName, Number value)
Escribe un elemento numérico que acepta valores NULL ( |
|
final
Xml |
writeNumberElement(String namespaceUri, String localName, Number value)
Escribe un elemento number que acepta valores NULL que tiene un prefijo ( |
|
final
Xml |
writeStartDocument()
Escribe el inicio del documento XML (""). |
|
abstract
Xml |
writeStartDocument(String version, String encoding)
Escribe el inicio del documento XML (""). |
|
final
Xml |
writeStartElement(String localName)
Comienza un inicio de elemento XML (''). |
|
abstract
Xml |
writeStartElement(String namespaceUri, String localName)
Comienza un inicio de elemento XML que tiene un prefijo (""). |
|
final
Xml |
writeStartSelfClosingElement(String localName)
Comienza un inicio de elemento XML que será de autocierre (""). |
|
abstract
Xml |
writeStartSelfClosingElement(String namespaceUri, String localName)
Comienza un inicio de elemento XML que tiene un prefijo que será de autocierre (""). |
|
abstract
Xml |
writeString(String value)
Escribe un valor directamente en un elemento XML ( |
|
final
Xml |
writeStringAttribute(String localName, String value)
Escribe un atributo String ( |
|
abstract
Xml |
writeStringAttribute(String namespaceUri, String localName, String value)
Escribe un atributo String que tiene un prefijo ( |
|
final
Xml |
writeStringElement(String localName, String value)
Escribe un elemento de cadena ( |
|
final
Xml |
writeStringElement(String namespaceUri, String localName, String value)
Escribe un elemento de cadena que tiene un prefijo ( |
|
final
Xml |
writeXml(XmlSerializable<?> value)
Escribe un XmlSerializable<T> objeto . |
|
final
Xml |
writeXml(XmlSerializable<?> value, String rootElementName)
Escribe un XmlSerializable<T> objeto . |
Métodos heredados de java.lang.Object
Detalles del constructor
XmlWriter
public XmlWriter()
Crea una instancia de XmlWriter.
Detalles del método
close
public abstract void close()
Cierra la secuencia XML.
Durante el cierre de la implementación de XmlWriter debe vaciar cualquier contenido sin vaciar.
Throws:
flush
public abstract XmlWriter flush()
Vacía cualquier contenido sin vaciar que se haya escrito en .XmlWriter
Returns:
Throws:
writeBinary
public final XmlWriter writeBinary(byte[] value)
Escribe un valor binario como una cadena base64.
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String localName, byte[] value)
Escribe un atributo binario como una cadena base64 (attribute="value").
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
Escribe un atributo binario como una cadena base64 que tiene un prefijo (prefix:attribute="value").
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String localName, byte[] value)
Escribe un elemento binario como una cadena base64 (value).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String namespaceUri, String localName, byte[] value)
Escribe un elemento binario como una cadena base64 que tiene un prefijo (value).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(boolean value)
Escribe un valor booleano.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(Boolean value)
Escribe un valor booleano que acepta valores NULL.
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, boolean value)
Escribe un atributo booleano (attribute="true").
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, Boolean value)
Escribe un atributo booleano que acepta valores NULL (attribute="false").
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Escribe un atributo booleano que tiene un prefijo (prefix:attribute="true").
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Escribe un atributo booleano que acepta valores NULL que tiene un prefijo (prefix:attribute="false").
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, boolean value)
Escribe un elemento booleano (true).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, Boolean value)
Escribe un elemento booleano que acepta valores NULL (true).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, boolean value)
Escribe un elemento booleano que tiene un prefijo (true).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, Boolean value)
Escribe un elemento booleano que acepta valores NULL que tiene un prefijo (true).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeCDataString
public abstract XmlWriter writeCDataString(String value)
Escribe un valor de CData directamente en un elemento XML (value).
Esto no escribe la etiqueta de inicio ni la etiqueta final del elemento XML.
Esta API es una comodidad para writeString(String value) los valores de CData, es posible usar writeString(String value) en lugar de esta API.
Parameters:
Returns:
Throws:
writeDouble
public final XmlWriter writeDouble(double value)
Escribe un valor doble.
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String localName, double value)
Escribe un atributo double (attribute="3.14").
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String namespaceUri, String localName, double value)
Escribe un atributo double que tiene un prefijo (prefix:attribute="3.14").
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String localName, double value)
Escribe un elemento double (3.14).
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String namespaceUri, String localName, double value)
Escribe un elemento double que tiene un prefijo (3.14).
Parameters:
Returns:
Throws:
writeEndElement
public abstract XmlWriter writeEndElement()
Finaliza el elemento XML actual escribiendo la etiqueta de cierre ('').
Esta llamada determinará el nombre y el prefijo de la etiqueta de elemento XML, si hay alguno, para cerrar el ámbito del elemento XML actual.
Returns:
Throws:
writeFloat
public final XmlWriter writeFloat(float value)
Escribe un valor float.
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String localName, float value)
Escribe un atributo float (attribute="2.7").
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String namespaceUri, String localName, float value)
Escribe un atributo float que tiene un prefijo (prefix:attribute="2.7").
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String localName, float value)
Escribe un elemento float (2.7).
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String namespaceUri, String localName, float value)
Escribe un elemento float que tiene un prefijo (2.7).
Parameters:
Returns:
Throws:
writeInt
public final XmlWriter writeInt(int value)
Escribe un valor int.
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String localName, int value)
Escribe un atributo int (attribute="10").
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String namespaceUri, String localName, int value)
Escribe un atributo int que tiene un prefijo (prefix:attribute="10").
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String localName, int value)
Escribe un elemento int (10).
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String namespaceUri, String localName, int value)
Escribe un elemento int que tiene un prefijo (10).
Parameters:
Returns:
Throws:
writeLong
public final XmlWriter writeLong(long value)
Escribe un valor largo.
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String namespaceUri, String localName, long value)
Escribe un atributo long que tiene un prefijo (prefix:attribute="100000000000").
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String localName, long value)
Escribe un atributo long (attribute="100000000000").
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String namespaceUri, String localName, long value)
Escribe un elemento long que tiene un prefijo (100000000000).
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String localName, long value)
Escribe un elemento long (100000000000).
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespaceUri)
Escribe un espacio de nombres XML predeterminado.
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespacePrefix, String namespaceUri)
Escribe un espacio de nombres XML con un prefijo especificado.
Si es namespacePrefix null o xmlns llama a este método es equivalente a writeNamespace(String namespaceUri).
Parameters:
Returns:
Throws:
writeNumber
public final XmlWriter writeNumber(Number value)
Escribe un número que acepta valores NULL.
Si value es null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String localName, Number value)
Escribe un atributo numérico que acepta valores NULL (attribute="number").
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String namespaceUri, String localName, Number value)
Escribe un atributo number que acepta valores NULL que tiene un prefijo (prefix:attribute="number").
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String localName, Number value)
Escribe un elemento numérico que acepta valores NULL (number).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String namespaceUri, String localName, Number value)
Escribe un elemento number que acepta valores NULL que tiene un prefijo (number).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeStartDocument
public final XmlWriter writeStartDocument()
Escribe el inicio del documento XML ("").
Usa la versión predeterminada y la codificación que son 1.0 y utf-8 respectivamente. Si se requiere writeStartDocument(String version, String encoding) una versión o codificación diferente, lo que permite especificar esos valores.
Returns:
Throws:
writeStartDocument
public abstract XmlWriter writeStartDocument(String version, String encoding)
Escribe el inicio del documento XML ("").
Tanto como versionencoding son opcionales y si no se pasan sus valores predeterminados se usarán. Para version el valor predeterminado es 1.0 y para encoding el valor predeterminado es utf-8.
Parameters:
Returns:
Throws:
writeStartElement
public final XmlWriter writeStartElement(String localName)
Comienza un inicio de elemento XML ('').
Esta llamada no cierra (>) el elemento XML se inicia, sino que lo aplaza hasta que una llamada comience otro elemento o escriba el cuerpo del elemento. Esto también requiere una llamada explícita para writeEndElement() finalizar el cuerpo del elemento XML.
Las llamadas a los atributos de escritura no cerrarán el elemento XML.
Parameters:
Returns:
Throws:
writeStartElement
public abstract XmlWriter writeStartElement(String namespaceUri, String localName)
Comienza un inicio de elemento XML que tiene un prefijo ("").
Esta llamada no cierra (>) el elemento XML se inicia, sino que lo aplaza hasta que una llamada comience otro elemento o escriba el cuerpo del elemento. Esto también requiere una llamada explícita para writeEndElement() finalizar el cuerpo del elemento XML.
Las llamadas a los atributos de escritura no cerrarán el elemento XML.
Si prefix es null, se comportará igual que writeStartElement(String localName).
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public final XmlWriter writeStartSelfClosingElement(String localName)
Comienza un inicio de elemento XML que será de autocierre ("").
Esta llamada no cierra (/>) el elemento XML se inicia, sino que lo aplaza hasta que se inicia una llamada a otro elemento. Si hay un intento de escribir el cuerpo del elemento después de iniciar un elemento de autoconcierto, se producirá un elemento IllegalStateException como elementos de autocierre no tiene un cuerpo.
Las llamadas a los atributos de escritura no cerrarán el elemento XML.
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public abstract XmlWriter writeStartSelfClosingElement(String namespaceUri, String localName)
Comienza un inicio de elemento XML que tiene un prefijo que será de autocierre ("").
Esta llamada no cierra (/>) el elemento XML se inicia, sino que lo aplaza hasta que se inicia una llamada a otro elemento. Si hay un intento de escribir el cuerpo del elemento después de iniciar un elemento de autoconcierto, se producirá un elemento IllegalStateException como elementos de autocierre no tiene un cuerpo.
Las llamadas a los atributos de escritura no cerrarán el elemento XML.
Si prefix es null, se comportará igual que writeStartSelfClosingElement(String localName).
Parameters:
Returns:
Throws:
writeString
public abstract XmlWriter writeString(String value)
Escribe un valor directamente en un elemento XML (value).
Esto no escribe la etiqueta de inicio ni la etiqueta final del elemento XML.
writeCDataString(String value) es una API útil si es necesario escribir un valor CData XML.
Parameters:
Returns:
Throws:
writeStringAttribute
public final XmlWriter writeStringAttribute(String localName, String value)
Escribe un atributo String (attribute="value").
Parameters:
Returns:
Throws:
writeStringAttribute
public abstract XmlWriter writeStringAttribute(String namespaceUri, String localName, String value)
Escribe un atributo String que tiene un prefijo (prefix:attribute="value").
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String localName, String value)
Escribe un elemento de cadena (string).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String namespaceUri, String localName, String value)
Escribe un elemento de cadena que tiene un prefijo (string).
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value)
Escribe un XmlSerializable<T> objeto .
Si es value null, se trata de una operación sin operación.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value, String rootElementName)
Escribe un XmlSerializable<T> objeto .
Si es value null, se trata de una operación sin operación.
Si rootElementName es null, esto es lo mismo que llamar a writeXml(XmlSerializable<?> value).
Parameters:
Returns:
Throws:
Se aplica a
Azure SDK for Java
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de