XmlSerializable<T> Interfaz

Paquete:

com.azure.xml

Artefacto Maven:

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

Parámetros de tipo

T

Tipo del objeto que es serializable XML.

public interface XmlSerializable

Indica que la clase de implementación se puede serializar y deserializar desde XML.

Puesto que la deserialización debe funcionar sin una instancia de la clase , se supone que la clase tiene un método fromXml(XmlReader) estático que deserializa una instancia de esa clase. El contrato para leer XML... TODO (alzimmer): finalice este javadoc.

Resumen del método

Modificador y tipo	Método y descripción
static T	fromXml(XmlReader xmlReader) Lee una secuencia XML en un objeto .
static T	fromXml(XmlReader xmlReader, String rootElementName) Lee una secuencia XML en un objeto .
abstract XmlWriter	toXml(XmlWriter xmlWriter) Escribe el objeto en el objeto pasado XmlWriter.
abstract XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName) Escribe el objeto en el objeto pasado XmlWriter.

Detalles del método

fromXml

public static T fromXml(XmlReader xmlReader)

Lee una secuencia XML en un objeto .

Las implementaciones de XmlSerializable<T> deben definir este método; de lo contrario, se producirá una UnsupportedOperationException excepción .

Parámetros:

xmlReader - Que XmlReader se va a leer.

Devoluciones:

El objeto representado por la secuencia XML puede devolver null.

Produce:

XMLStreamException

- Si no se puede leer un objeto de .xmlReader

fromXml

public static T fromXml(XmlReader xmlReader, String rootElementName)

Lee una secuencia XML en un objeto .

Las implementaciones de XmlSerializable<T> deben definir este método; de lo contrario, se producirá una UnsupportedOperationException excepción .

Parámetros:

xmlReader - Que XmlReader se va a leer.

rootElementName - Nombre de elemento raíz opcional para invalidar el valor predeterminado definido por el modelo. Se usa para admitir casos en los que el modelo puede deserializarse a partir de nombres de elementos raíz diferentes.

Devoluciones:

El objeto representado por la secuencia XML puede devolver null.

Produce:

XMLStreamException

- Si no se puede leer un objeto de .xmlReader

toXml

public abstract XmlWriter toXml(XmlWriter xmlWriter)

Escribe el objeto en el objeto pasado XmlWriter.

El contrato para escribir XML en es que el objeto que se va a XmlWriter escribir controlará la apertura y el cierre de su propio objeto XML. Por lo tanto, para los objetos que llaman a otros XmlSerializable<T> objetos para la serialización, pasarán al XmlWriter otro XmlSerializable<T> objeto. De este modo, los objetos que escriben XML se encapsularán automáticamente para escribir XML con el formato correcto.

Parámetros:

xmlWriter - Objeto en el XmlWriter que se escribe.

Devoluciones:

donde XmlWriter se escribió el JSON para encadenar.

Produce:

XMLStreamException

- Si el objeto no se puede escribir en .xmlWriter

toXml

public abstract XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Escribe el objeto en el objeto pasado XmlWriter.

El contrato para escribir XML en es que el objeto que se va a XmlWriter escribir controlará la apertura y el cierre de su propio objeto XML. Por lo tanto, para los objetos que llaman a otros XmlSerializable<T> objetos para la serialización, pasarán al XmlWriter otro XmlSerializable<T> objeto. De este modo, los objetos que escriben XML se encapsularán automáticamente para escribir XML con el formato correcto.

Parámetros:

xmlWriter - Objeto en el XmlWriter que se escribe.

rootElementName - Nombre de elemento raíz opcional para invalidar el valor predeterminado definido por el modelo. Se usa para admitir casos en los que el modelo puede serializarse mediante nombres de elementos raíz diferentes.

Devoluciones:

donde XmlWriter se escribió el JSON para encadenar.

Produce:

XMLStreamException

- Si el objeto no se puede escribir en .xmlWriter