Compartilhar via

XmlSerializable<T> Interface

  • Referência
Pacote:
com.azure.xml
Artefato Maven:
com.azure:azure-xml:1.0.0-beta.3

Parâmetros de tipo

T

O tipo do objeto que é serializável XML.

public interface XmlSerializable

Indica que a classe de implementação pode ser serializada e desserializada de XML.

Como a desserialização precisa funcionar sem uma instância da classe , implementando essa interface, supõe-se que a classe tenha um método fromXml(XmlReader) estático que desserializa uma instância dessa classe. O contrato para leitura de XML... TODO (alzimmer): conclua este javadoc

Resumo do método

Modificador e tipo Método e descrição
static T fromXml(XmlReader xmlReader)

Lê um fluxo XML em um objeto .
static T fromXml(XmlReader xmlReader, String rootElementName)

Lê um fluxo XML em um objeto .
abstract XmlWriter toXml(XmlWriter xmlWriter)

Grava o objeto no passado XmlWriter.
abstract XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Grava o objeto no passado XmlWriter.

Detalhes do método

fromXml

public static T fromXml(XmlReader xmlReader)

Lê um fluxo XML em um objeto .

As implementações de XmlSerializable<T> devem definir esse método, caso contrário, um UnsupportedOperationException será gerado.

Parameters:

xmlReader - O XmlReader que está sendo lido.

Returns:

O objeto representado pelo fluxo XML pode retornar nulo.

Throws:

XMLStreamException

 - Se um objeto não for lido do xmlReader.

fromXml

public static T fromXml(XmlReader xmlReader, String rootElementName)

Lê um fluxo XML em um objeto .

As implementações de XmlSerializable<T> devem definir esse método, caso contrário, um UnsupportedOperationException será gerado.

Parameters:

xmlReader - O XmlReader que está sendo lido.
rootElementName - Nome do elemento raiz opcional para substituir o padrão definido pelo modelo. Usado para dar suporte a casos em que o modelo pode desserializar de diferentes nomes de elemento raiz.

Returns:

O objeto representado pelo fluxo XML pode retornar nulo.

Throws:

XMLStreamException

 - Se um objeto não for lido do xmlReader.

toXml

public abstract XmlWriter toXml(XmlWriter xmlWriter)

Grava o objeto no passado XmlWriter.

O contrato para gravar XML XmlWriter é que o objeto que está sendo gravado manipulará a abertura e o fechamento de seu próprio objeto XML. Portanto, para objetos que chamam outros XmlSerializable<T> objetos para serialização, eles passarão o XmlWriter para o outro XmlSerializable<T> objeto. Dessa forma, os objetos que gravam XML serão auto-encapsulados para gravar XML formatado corretamente.

Parameters:

xmlWriter - O XmlWriter que está sendo escrito.

Returns:

O XmlWriter em que o JSON foi escrito para encadeamento.

Throws:

XMLStreamException

 - Se o objeto não for gravado no xmlWriter.

toXml

public abstract XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Grava o objeto no passado XmlWriter.

O contrato para gravar XML XmlWriter é que o objeto que está sendo gravado manipulará a abertura e o fechamento de seu próprio objeto XML. Portanto, para objetos que chamam outros XmlSerializable<T> objetos para serialização, eles passarão o XmlWriter para o outro XmlSerializable<T> objeto. Dessa forma, os objetos que gravam XML serão auto-encapsulados para gravar XML formatado corretamente.

Parameters:

xmlWriter - O XmlWriter que está sendo escrito.
rootElementName - Nome do elemento raiz opcional para substituir o padrão definido pelo modelo. Usado para dar suporte a casos em que o modelo pode serializar usando nomes de elemento raiz diferentes.

Returns:

O XmlWriter em que o JSON foi escrito para encadeamento.

Throws:

XMLStreamException

 - Se o objeto não for gravado no xmlWriter.

Aplica-se a