XmlWriter Classe
- java.
lang. Object - com.
azure. xml. XmlWriter
- com.
Implémente
public abstract class XmlWriter
implements AutoCloseable
Écrit une valeur encodée XML dans un flux.
Récapitulatif du constructeur
Constructeur | Description |
---|---|
XmlWriter() |
Crée une instance de XmlWriter. |
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
abstract void |
close()
Ferme le flux XML. |
abstract
Xml |
flush()
Vide tout contenu non vidé qui a été écrit dans .XmlWriter |
final
Xml |
writeBinary(byte[] value)
Écrit une valeur binaire sous forme de chaîne base64. |
final
Xml |
writeBinaryAttribute(String localName, byte[] value)
Écrit un attribut binaire en tant que chaîne base64 ( |
final
Xml |
writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
Écrit un attribut binaire sous la forme d’une chaîne base64 qui a un préfixe ( |
final
Xml |
writeBinaryElement(String localName, byte[] value)
Écrit un élément binaire sous forme de chaîne base64 ( |
final
Xml |
writeBinaryElement(String namespaceUri, String localName, byte[] value)
Écrit un élément binaire sous la forme d’une chaîne base64 qui a un préfixe ( |
final
Xml |
writeBoolean(boolean value)
Écrit une valeur booléenne. |
final
Xml |
writeBoolean(Boolean value)
Écrit une valeur booléenne nullable. |
final
Xml |
writeBooleanAttribute(String localName, boolean value)
Écrit un attribut booléen ( |
final
Xml |
writeBooleanAttribute(String localName, Boolean value)
Écrit un attribut booléen nullable ( |
final
Xml |
writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Écrit un attribut booléen qui a un préfixe ( |
final
Xml |
writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Écrit un attribut booléen nullable qui a un préfixe ( |
final
Xml |
writeBooleanElement(String localName, boolean value)
Écrit un élément booléen ( |
final
Xml |
writeBooleanElement(String localName, Boolean value)
Écrit un élément booléen nullable ( |
final
Xml |
writeBooleanElement(String namespaceUri, String localName, boolean value)
Écrit un élément booléen qui a un préfixe ( |
final
Xml |
writeBooleanElement(String namespaceUri, String localName, Boolean value)
Écrit un élément booléen nullable qui a un préfixe ( |
abstract
Xml |
writeCDataString(String value)
Écrit une valeur CData directement dans un élément XML ( |
final
Xml |
writeDouble(double value)
Écrit une valeur double. |
final
Xml |
writeDoubleAttribute(String localName, double value)
Écrit un attribut double ( |
final
Xml |
writeDoubleAttribute(String namespaceUri, String localName, double value)
Écrit un attribut double qui a un préfixe ( |
final
Xml |
writeDoubleElement(String localName, double value)
Écrit un élément double ( |
final
Xml |
writeDoubleElement(String namespaceUri, String localName, double value)
Écrit un élément double qui a un préfixe ( |
abstract
Xml |
writeEndElement()
Termine l’élément XML actuel en écrivant la balise fermante (« »). |
final
Xml |
writeFloat(float value)
Écrit une valeur float. |
final
Xml |
writeFloatAttribute(String localName, float value)
Écrit un attribut float ( |
final
Xml |
writeFloatAttribute(String namespaceUri, String localName, float value)
Écrit un attribut float qui a un préfixe ( |
final
Xml |
writeFloatElement(String localName, float value)
Écrit un élément float ( |
final
Xml |
writeFloatElement(String namespaceUri, String localName, float value)
Écrit un élément float qui a un préfixe ( |
final
Xml |
writeInt(int value)
Écrit une valeur int. |
final
Xml |
writeIntAttribute(String localName, int value)
Écrit un attribut int ( |
final
Xml |
writeIntAttribute(String namespaceUri, String localName, int value)
Écrit un attribut int qui a un préfixe ( |
final
Xml |
writeIntElement(String localName, int value)
Écrit un élément int ( |
final
Xml |
writeIntElement(String namespaceUri, String localName, int value)
Écrit un élément int qui a un préfixe ( |
final
Xml |
writeLong(long value)
Écrit une valeur longue. |
final
Xml |
writeLongAttribute(String namespaceUri, String localName, long value)
Écrit un attribut long qui a un préfixe ( |
final
Xml |
writeLongAttribute(String localName, long value)
Écrit un attribut long ( |
final
Xml |
writeLongElement(String namespaceUri, String localName, long value)
Écrit un élément long qui a un préfixe ( |
final
Xml |
writeLongElement(String localName, long value)
Écrit un élément long ( |
abstract
Xml |
writeNamespace(String namespaceUri)
Écrit un espace de noms XML par défaut. |
abstract
Xml |
writeNamespace(String namespacePrefix, String namespaceUri)
Écrit un espace de noms XML avec un préfixe spécifié. |
final
Xml |
writeNumber(Number value)
Écrit un nombre nullable. |
final
Xml |
writeNumberAttribute(String localName, Number value)
Écrit un attribut de nombre nullable ( |
final
Xml |
writeNumberAttribute(String namespaceUri, String localName, Number value)
Écrit un attribut de nombre nullable qui a un préfixe ( |
final
Xml |
writeNumberElement(String localName, Number value)
Écrit un élément nombre nullable ( |
final
Xml |
writeNumberElement(String namespaceUri, String localName, Number value)
Écrit un élément nombre nullable qui a un préfixe ( |
final
Xml |
writeStartDocument()
Écrit le début du document XML (''). |
abstract
Xml |
writeStartDocument(String version, String encoding)
Écrit le début du document XML (''). |
final
Xml |
writeStartElement(String localName)
Commence le démarrage d’un élément XML (''). |
abstract
Xml |
writeStartElement(String namespaceUri, String localName)
Commence un début d’élément XML qui a un préfixe (« ' »). |
final
Xml |
writeStartSelfClosingElement(String localName)
Commence un démarrage d’élément XML qui se fermera automatiquement (''). |
abstract
Xml |
writeStartSelfClosingElement(String namespaceUri, String localName)
Commence un démarrage d’élément XML qui a un préfixe qui se fermera automatiquement (''). |
abstract
Xml |
writeString(String value)
Écrit une valeur directement dans un élément XML ( |
final
Xml |
writeStringAttribute(String localName, String value)
Écrit un attribut String ( |
abstract
Xml |
writeStringAttribute(String namespaceUri, String localName, String value)
Écrit un attribut String qui a un préfixe ( |
final
Xml |
writeStringElement(String localName, String value)
Écrit un élément string ( |
final
Xml |
writeStringElement(String namespaceUri, String localName, String value)
Écrit un élément de chaîne qui a un préfixe ( |
final
Xml |
writeXml(XmlSerializable<?> value)
Écrit un XmlSerializable<T> objet. |
final
Xml |
writeXml(XmlSerializable<?> value, String rootElementName)
Écrit un XmlSerializable<T> objet. |
Méthodes héritées de java.lang.Object
Détails du constructeur
XmlWriter
public XmlWriter()
Crée une instance de XmlWriter.
Détails de la méthode
close
public abstract void close()
Ferme le flux XML.
Lors de la fermeture, l’implémentation de XmlWriter doit vider tout contenu non vidé.
Throws:
flush
public abstract XmlWriter flush()
Vide tout contenu non vidé qui a été écrit dans .XmlWriter
Returns:
Throws:
writeBinary
public final XmlWriter writeBinary(byte[] value)
Écrit une valeur binaire sous forme de chaîne base64.
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String localName, byte[] value)
Écrit un attribut binaire en tant que chaîne base64 (attribute="value"
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBinaryAttribute
public final XmlWriter writeBinaryAttribute(String namespaceUri, String localName, byte[] value)
Écrit un attribut binaire sous la forme d’une chaîne base64 qui a un préfixe (prefix:attribute="value"
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String localName, byte[] value)
Écrit un élément binaire sous forme de chaîne base64 (value
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBinaryElement
public final XmlWriter writeBinaryElement(String namespaceUri, String localName, byte[] value)
Écrit un élément binaire sous la forme d’une chaîne base64 qui a un préfixe (value
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(boolean value)
Écrit une valeur booléenne.
Parameters:
Returns:
Throws:
writeBoolean
public final XmlWriter writeBoolean(Boolean value)
Écrit une valeur booléenne nullable.
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, boolean value)
Écrit un attribut booléen (attribute="true"
).
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String localName, Boolean value)
Écrit un attribut booléen nullable (attribute="false"
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, boolean value)
Écrit un attribut booléen qui a un préfixe (prefix:attribute="true"
).
Parameters:
Returns:
Throws:
writeBooleanAttribute
public final XmlWriter writeBooleanAttribute(String namespaceUri, String localName, Boolean value)
Écrit un attribut booléen nullable qui a un préfixe (prefix:attribute="false"
).
Si a la value
valeur Null, il s’agit d’une opération sans opération.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, boolean value)
Écrit un élément booléen (true
).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String localName, Boolean value)
Écrit un élément booléen nullable (true
).
Si a la value
valeur Null, il s’agit d’une opération sans opération.
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, boolean value)
Écrit un élément booléen qui a un préfixe (true
).
Parameters:
Returns:
Throws:
writeBooleanElement
public final XmlWriter writeBooleanElement(String namespaceUri, String localName, Boolean value)
Écrit un élément booléen nullable qui a un préfixe (true
).
Si a la value
valeur Null, il s’agit d’une opération sans opération.
Parameters:
Returns:
Throws:
writeCDataString
public abstract XmlWriter writeCDataString(String value)
Écrit une valeur CData directement dans un élément XML (value
).
Cela n’écrit pas la balise de début ou de fin de l’élément XML.
Cette API est pratique pour les writeString(String value) valeurs CData, il est possible d’utiliser writeString(String value) à la place de cette API.
Parameters:
Returns:
Throws:
writeDouble
public final XmlWriter writeDouble(double value)
Écrit une valeur double.
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String localName, double value)
Écrit un attribut double (attribute="3.14"
).
Parameters:
Returns:
Throws:
writeDoubleAttribute
public final XmlWriter writeDoubleAttribute(String namespaceUri, String localName, double value)
Écrit un attribut double qui a un préfixe (prefix:attribute="3.14"
).
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String localName, double value)
Écrit un élément double (3.14
).
Parameters:
Returns:
Throws:
writeDoubleElement
public final XmlWriter writeDoubleElement(String namespaceUri, String localName, double value)
Écrit un élément double qui a un préfixe (3.14
).
Parameters:
Returns:
Throws:
writeEndElement
public abstract XmlWriter writeEndElement()
Termine l’élément XML actuel en écrivant la balise fermante (« »).
Cet appel détermine le nom et le préfixe de balise d’élément XML, le cas échéant, pour fermer l’étendue de l’élément XML actuelle.
Returns:
Throws:
writeFloat
public final XmlWriter writeFloat(float value)
Écrit une valeur float.
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String localName, float value)
Écrit un attribut float (attribute="2.7"
).
Parameters:
Returns:
Throws:
writeFloatAttribute
public final XmlWriter writeFloatAttribute(String namespaceUri, String localName, float value)
Écrit un attribut float qui a un préfixe (prefix:attribute="2.7"
).
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String localName, float value)
Écrit un élément float (2.7
).
Parameters:
Returns:
Throws:
writeFloatElement
public final XmlWriter writeFloatElement(String namespaceUri, String localName, float value)
Écrit un élément float qui a un préfixe (2.7
).
Parameters:
Returns:
Throws:
writeInt
public final XmlWriter writeInt(int value)
Écrit une valeur int.
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String localName, int value)
Écrit un attribut int (attribute="10"
).
Parameters:
Returns:
Throws:
writeIntAttribute
public final XmlWriter writeIntAttribute(String namespaceUri, String localName, int value)
Écrit un attribut int qui a un préfixe (prefix:attribute="10"
).
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String localName, int value)
Écrit un élément int (10
).
Parameters:
Returns:
Throws:
writeIntElement
public final XmlWriter writeIntElement(String namespaceUri, String localName, int value)
Écrit un élément int qui a un préfixe (10
).
Parameters:
Returns:
Throws:
writeLong
public final XmlWriter writeLong(long value)
Écrit une valeur longue.
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String namespaceUri, String localName, long value)
Écrit un attribut long qui a un préfixe (prefix:attribute="100000000000"
).
Parameters:
Returns:
Throws:
writeLongAttribute
public final XmlWriter writeLongAttribute(String localName, long value)
Écrit un attribut long (attribute="100000000000"
).
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String namespaceUri, String localName, long value)
Écrit un élément long qui a un préfixe (100000000000
).
Parameters:
Returns:
Throws:
writeLongElement
public final XmlWriter writeLongElement(String localName, long value)
Écrit un élément long (100000000000
).
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespaceUri)
Écrit un espace de noms XML par défaut.
Parameters:
Returns:
Throws:
writeNamespace
public abstract XmlWriter writeNamespace(String namespacePrefix, String namespaceUri)
Écrit un espace de noms XML avec un préfixe spécifié.
Si a la namespacePrefix
valeur null ou xmlns
si l’appel de cette méthode équivaut à writeNamespace(String namespaceUri).
Parameters:
Returns:
Throws:
writeNumber
public final XmlWriter writeNumber(Number value)
Écrit un nombre nullable.
Si value
a la valeur null, il s’agit d’une opération sans opération.
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String localName, Number value)
Écrit un attribut de nombre nullable (attribute="number"
).
Parameters:
Returns:
Throws:
writeNumberAttribute
public final XmlWriter writeNumberAttribute(String namespaceUri, String localName, Number value)
Écrit un attribut de nombre nullable qui a un préfixe (prefix:attribute="number"
).
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String localName, Number value)
Écrit un élément nombre nullable (number
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeNumberElement
public final XmlWriter writeNumberElement(String namespaceUri, String localName, Number value)
Écrit un élément nombre nullable qui a un préfixe (number
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeStartDocument
public final XmlWriter writeStartDocument()
Écrit le début du document XML ('').
Cela utilise la version par défaut et l’encodage qui sont 1.0
et utf-8
respectivement. Si une autre version ou encodage est nécessaire, utilisez writeStartDocument(String version, String encoding) ce qui permet de spécifier ces valeurs.
Returns:
Throws:
writeStartDocument
public abstract XmlWriter writeStartDocument(String version, String encoding)
Écrit le début du document XML ('').
Les deux version
et encoding
sont facultatifs et s’ils ne sont pas transmis, leurs valeurs par défaut seront utilisées. Pour version
la valeur par défaut est 1.0
et pour encoding
la valeur par défaut est utf-8
.
Parameters:
Returns:
Throws:
writeStartElement
public final XmlWriter writeStartElement(String localName)
Commence le démarrage d’un élément XML ('').
Cet appel ne ferme pas (>
) le début de l’élément XML, mais le reporte jusqu’à un appel pour commencer un autre élément ou écrire le corps de l’élément. Cela nécessite également un appel explicite à writeEndElement() pour mettre fin au corps de l’élément XML.
Les appels à écrire des attributs ne ferment pas l’élément XML.
Parameters:
Returns:
Throws:
writeStartElement
public abstract XmlWriter writeStartElement(String namespaceUri, String localName)
Commence un début d’élément XML qui a un préfixe (« ' »).
Cet appel ne ferme pas (>
) le début de l’élément XML, mais le reporte jusqu’à un appel pour commencer un autre élément ou écrire le corps de l’élément. Cela nécessite également un appel explicite à writeEndElement() pour mettre fin au corps de l’élément XML.
Les appels à écrire des attributs ne ferment pas l’élément XML.
Si prefix
a la valeur null, cela se comporte de la même façon que writeStartElement(String localName).
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public final XmlWriter writeStartSelfClosingElement(String localName)
Commence un démarrage d’élément XML qui se fermera automatiquement ('').
Cet appel ne ferme pas (/>
) le début de l’élément XML, mais le reporte jusqu’à un appel pour commencer un autre élément. S’il y a une tentative d’écriture du corps de l’élément après avoir commencé un élément à fermeture automatique, un IllegalStateException élément sera levée car les éléments à fermeture automatique n’ont pas de corps.
Les appels à écrire des attributs ne ferment pas l’élément XML.
Parameters:
Returns:
Throws:
writeStartSelfClosingElement
public abstract XmlWriter writeStartSelfClosingElement(String namespaceUri, String localName)
Commence un démarrage d’élément XML qui a un préfixe qui se fermera automatiquement ('').
Cet appel ne ferme pas (/>
) le début de l’élément XML, mais le reporte jusqu’à un appel pour commencer un autre élément. S’il y a une tentative d’écriture du corps de l’élément après avoir commencé un élément à fermeture automatique, un IllegalStateException élément sera levée car les éléments à fermeture automatique n’ont pas de corps.
Les appels à écrire des attributs ne ferment pas l’élément XML.
Si prefix
a la valeur null, cela se comporte de la même façon que writeStartSelfClosingElement(String localName).
Parameters:
Returns:
Throws:
writeString
public abstract XmlWriter writeString(String value)
Écrit une valeur directement dans un élément XML (value
).
Cela n’écrit pas la balise de début ou de fin de l’élément XML.
writeCDataString(String value) est une API pratique si une valeur CData XML doit être écrite.
Parameters:
Returns:
Throws:
writeStringAttribute
public final XmlWriter writeStringAttribute(String localName, String value)
Écrit un attribut String (attribute="value"
).
Parameters:
Returns:
Throws:
writeStringAttribute
public abstract XmlWriter writeStringAttribute(String namespaceUri, String localName, String value)
Écrit un attribut String qui a un préfixe (prefix:attribute="value"
).
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String localName, String value)
Écrit un élément string (string
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeStringElement
public final XmlWriter writeStringElement(String namespaceUri, String localName, String value)
Écrit un élément de chaîne qui a un préfixe (string
).
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value)
Écrit un XmlSerializable<T> objet.
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Parameters:
Returns:
Throws:
writeXml
public final XmlWriter writeXml(XmlSerializable value, String rootElementName)
Écrit un XmlSerializable<T> objet.
Si le a la value
valeur Null, il s’agit d’une opération de non-opération.
Si rootElementName
a la valeur null, il s’agit de l’appel de writeXml(XmlSerializable<?> value).
Parameters:
Returns:
Throws:
S’applique à
Azure SDK for Java