XmlSerializable<T> Interface

Paquet:

com.azure.xml

Artefact Maven:

com.azure:azure-xml:1.0.0-beta.3

Paramètres de type

T

Type de l’objet qui est sérialisable XML.

public interface XmlSerializable

Indique que la classe d’implémentation peut être sérialisée dans et désérialisée à partir de XML.

Étant donné que la désérialisation doit fonctionner sans instance de la classe, l’implémentation de cette interface suppose que la classe a une méthode fromXml(XmlReader) statique qui désérialise un instance de cette classe. Le contrat pour la lecture du code XML... TODO (alzimmer) : terminer ce javadoc

Résumé de la méthode

Modificateur et type	Méthode et description
static T	fromXml(XmlReader xmlReader) Lit un flux XML dans un objet .
static T	fromXml(XmlReader xmlReader, String rootElementName) Lit un flux XML dans un objet .
abstract XmlWriter	toXml(XmlWriter xmlWriter) Écrit l’objet dans le passé XmlWriter.
abstract XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName) Écrit l’objet dans le passé XmlWriter.

Détails de la méthode

fromXml

public static T fromXml(XmlReader xmlReader)

Lit un flux XML dans un objet .

Les implémentations de XmlSerializable<T> doivent définir cette méthode, sinon une UnsupportedOperationException exception est levée.

Paramètres:

xmlReader - en XmlReader cours de lecture.

Retours:

L’objet représenté par le flux XML peut retourner null.

Exception:

XMLStreamException

- Si un objet ne parvient pas à être lu à partir du xmlReader.

fromXml

public static T fromXml(XmlReader xmlReader, String rootElementName)

Lit un flux XML dans un objet .

Les implémentations de XmlSerializable<T> doivent définir cette méthode, sinon une UnsupportedOperationException exception est levée.

Paramètres:

xmlReader - en XmlReader cours de lecture.

rootElementName - Nom d’élément racine facultatif pour remplacer la valeur par défaut définie par le modèle. Utilisé pour prendre en charge les cas où le modèle peut désérialiser à partir de différents noms d’éléments racine.

Retours:

L’objet représenté par le flux XML peut retourner null.

Exception:

XMLStreamException

- Si un objet ne parvient pas à être lu à partir du xmlReader.

toXml

public abstract XmlWriter toXml(XmlWriter xmlWriter)

Écrit l’objet dans le passé XmlWriter.

Le contrat d’écriture de XML XmlWriter dans est que l’objet en cours d’écriture gère l’ouverture et la fermeture de son propre objet XML. Ainsi, pour les objets appelant d’autres XmlSerializable<T> objets pour sérialisation, ils passent le XmlWriter à l’autre XmlSerializable<T> objet. De cette façon, les objets qui écrivent du code XML seront auto-encapsulés pour écrire du code XML correctement mis en forme.

Paramètres:

xmlWriter - en XmlWriter cours d’écriture.

Retours:

où XmlWriter le JSON a été écrit pour le chaînage.

Exception:

XMLStreamException

- Si l’objet ne parvient pas à être écrit dans .xmlWriter

toXml

public abstract XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Écrit l’objet dans le passé XmlWriter.

Le contrat d’écriture de XML XmlWriter dans est que l’objet en cours d’écriture gère l’ouverture et la fermeture de son propre objet XML. Ainsi, pour les objets appelant d’autres XmlSerializable<T> objets pour sérialisation, ils passent le XmlWriter à l’autre XmlSerializable<T> objet. De cette façon, les objets qui écrivent du code XML seront auto-encapsulés pour écrire du code XML correctement mis en forme.

Paramètres:

xmlWriter - en XmlWriter cours d’écriture.

rootElementName - Nom d’élément racine facultatif pour remplacer la valeur par défaut définie par le modèle. Utilisé pour prendre en charge les cas où le modèle peut sérialiser à l’aide de différents noms d’éléments racines.

Retours:

où XmlWriter le JSON a été écrit pour le chaînage.

Exception:

XMLStreamException

- Si l’objet ne parvient pas à être écrit dans .xmlWriter