XmlReader Classe

Pacote:

com.azure.xml

Artefato Maven:

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

• java.lang.Object
• • com.azure.xml.XmlReader

Implementações

AutoCloseable

public abstract class XmlReader
implements AutoCloseable

Lê um valor codificado em XML como um fluxo de tokens.

Resumo do Construtor

Construtor	Description
XmlReader()	Cria uma instância de XmlReader.

Resumo do método

Modificador e tipo	Método e descrição
final T	getNullableAttribute(String namespaceUri, String localName, ReadValueCallback<String,T> converter) Obtém o valor anulável para o atributo no elemento XML.
final T	getNullableElement(ReadValueCallback<String,T> converter) Obtém o valor anulável para o elemento atual.
final T	readObject(String localName, ReadValueCallback<XmlReader,T> converter) Lê um objeto do fluxo XML.
final T	readObject(String namespaceUri, String localName, ReadValueCallback<XmlReader,T> converter) Lê um objeto do fluxo XML.
abstract void	close() Fecha o fluxo XML.
abstract XmlToken	currentToken() Obtém o para o XmlToken qual o leitor aponta atualmente.
final byte[]	getBinaryAttribute(String namespaceUri, String localName) Obtém o valor binário do atributo no elemento XML.
final byte[]	getBinaryElement() Obtém o valor binário do elemento atual.
final boolean	getBooleanAttribute(String namespaceUri, String localName) Obtém o valor booliano do atributo no elemento XML.
final boolean	getBooleanElement() Obtém o valor booliano para o elemento atual.
final double	getDoubleAttribute(String namespaceUri, String localName) Obtém o valor duplo para o atributo no elemento XML.
final double	getDoubleElement() Obtém o valor duplo para o elemento atual.
abstract QName	getElementName() Obtém o QName para o elemento XML atual.
final float	getFloatAttribute(String namespaceUri, String localName) Obtém o valor float para o atributo no elemento XML.
final float	getFloatElement() Obtém o valor float para o elemento atual.
final int	getIntAttribute(String namespaceUri, String localName) Obtém o valor int do atributo no elemento XML.
final int	getIntElement() Obtém o valor int do elemento atual.
final long	getLongAttribute(String namespaceUri, String localName) Obtém o valor longo do atributo no elemento XML.
final long	getLongElement() Obtém o valor longo para o elemento atual.
abstract String	getStringAttribute(String namespaceUri, String localName) Obtém o valor da cadeia de caracteres para o atributo no elemento XML.
abstract String	getStringElement() Obtém o valor da cadeia de caracteres para o elemento atual.
abstract XmlToken	nextElement() Itera para e retorna o próximo START_ELEMENT ou END_ELEMENT no fluxo XML.
final void	skipElement() Ignora o elemento XML atual.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

XmlReader

public XmlReader()

Cria uma instância de XmlReader.

Detalhes do método

getNullableAttribute

public final T getNullableAttribute(String namespaceUri, String localName, ReadValueCallback converter)

Obtém o valor anulável para o atributo no elemento XML.

Se o atributo não tiver um valor ou não existir nulo será retornado, caso contrário, o atributo getStringAttribute(String namespaceUri, String localName) será passado para o conversor.

Parâmetros:

namespaceUri - O namespace do atributo pode ser nulo.

localName - Nome local do atributo.

converter - Função que converte o valor de texto do atributo para o tipo que permite valor nulo.

Retornos:

O valor de texto convertido ou nulo se o atributo não tiver um valor.

Gera:

XMLStreamException

- Se o atributo anulável não puder ser lido.

getNullableElement

public final T getNullableElement(ReadValueCallback converter)

Obtém o valor anulável para o elemento atual.

Se o elemento atual não tiver um valor nulo será retornado, caso contrário, o elemento getStringElement() será passado para o conversor.

Parâmetros:

converter - Função que converte o valor de texto do elemento para o tipo que permite valor nulo.

Retornos:

O valor de texto convertido ou nulo se o elemento não tiver um valor.

Gera:

XMLStreamException

- Se o elemento anulável não puder ser lido.

readObject

public final T readObject(String localName, ReadValueCallback converter)

Lê um objeto do fluxo XML.

Valida se o XmlReader está apontando para um START_ELEMENT que tem o nome qualificado especificado pelo startTagName.

Parâmetros:

localName - O nome local inicial esperado para o objeto .

converter - A função que lê o objeto .

Retornos:

Uma instância do objeto esperado,

Gera:

XMLStreamException

- Se a marca inicial não XmlToken#START_ELEMENT for ou a marca não corresponder à esperada startTagName

readObject

public final T readObject(String namespaceUri, String localName, ReadValueCallback converter)

Lê um objeto do fluxo XML.

Valida se o XmlReader está apontando para um START_ELEMENT que tem o nome qualificado especificado pelo startTagName.

Parâmetros:

namespaceUri - O namespace de espera para o objeto .

localName - O nome local inicial esperado para o objeto .

converter - A função que lê o objeto .

Retornos:

Uma instância do objeto esperado,

Gera:

XMLStreamException

- Se a marca inicial não XmlToken#START_ELEMENT for ou a marca não corresponder à esperada startTagName

close

public abstract void close()

Fecha o fluxo XML.

Gera:

XMLStreamException

- Se o repositório de conteúdo subjacente não for fechado.

currentToken

public abstract XmlToken currentToken()

Obtém o para o XmlToken qual o leitor aponta atualmente.

Retorna START_DOCUMENT se o leitor ainda não começou a ler o fluxo XML. Retornará END_DOCUMENT se o leitor tiver concluído a leitura do fluxo XML.

Retornos:

O XmlToken para o qual o leitor aponta atualmente.

getBinaryAttribute

public final byte[] getBinaryAttribute(String namespaceUri, String localName)

Obtém o valor binário do atributo no elemento XML.

Parâmetros:

namespaceUri - O namespace do atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor binário do atributo no elemento XML.

getBinaryElement

public final byte[] getBinaryElement()

Obtém o valor binário do elemento atual.

Retornos:

O valor binário do elemento atual.

Gera:

XMLStreamException

- Se o elemento binário não puder ser lido.

getBooleanAttribute

public final boolean getBooleanAttribute(String namespaceUri, String localName)

Obtém o valor booliano do atributo no elemento XML.

Parâmetros:

namespaceUri - O namespace de atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor booliano do atributo no elemento XML.

getBooleanElement

public final boolean getBooleanElement()

Obtém o valor booliano para o elemento atual.

Retornos:

O valor booliano do elemento atual.

Gera:

XMLStreamException

- Se o elemento booliano não puder ser lido.

getDoubleAttribute

public final double getDoubleAttribute(String namespaceUri, String localName)

Obtém o valor duplo para o atributo no elemento XML.

Parâmetros:

namespaceUri - O namespace de atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor duplo para o atributo no elemento XML.

getDoubleElement

public final double getDoubleElement()

Obtém o valor duplo para o elemento atual.

Retornos:

O valor duplo para o elemento atual.

Gera:

XMLStreamException

- Se o elemento duplo não puder ser lido.

getElementName

public abstract QName getElementName()

Obtém o QName para o elemento XML atual.

Retornos:

O QName para o elemento XML atual.

getFloatAttribute

public final float getFloatAttribute(String namespaceUri, String localName)

Obtém o valor float para o atributo no elemento XML.

Parâmetros:

namespaceUri - O namespace de atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor float do atributo no elemento XML.

getFloatElement

public final float getFloatElement()

Obtém o valor float para o elemento atual.

Retornos:

O valor float do elemento atual.

Gera:

XMLStreamException

- Se o elemento float não puder ser lido.

getIntAttribute

public final int getIntAttribute(String namespaceUri, String localName)

Obtém o valor int do atributo no elemento XML.

Parâmetros:

namespaceUri - O namespace de atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor int do atributo no elemento XML.

getIntElement

public final int getIntElement()

Obtém o valor int do elemento atual.

Retornos:

O valor int do elemento atual.

Gera:

XMLStreamException

- Se o elemento int não puder ser lido.

getLongAttribute

public final long getLongAttribute(String namespaceUri, String localName)

Obtém o valor longo do atributo no elemento XML.

Parâmetros:

namespaceUri - O namespace de atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor longo do atributo no elemento XML.

getLongElement

public final long getLongElement()

Obtém o valor longo para o elemento atual.

Retornos:

O valor longo para o elemento atual.

Gera:

XMLStreamException

- Se o elemento long não puder ser lido.

getStringAttribute

public abstract String getStringAttribute(String namespaceUri, String localName)

Obtém o valor da cadeia de caracteres para o atributo no elemento XML.

Null será retornado se o atributo não existir no elemento XML.

Parâmetros:

namespaceUri - O namespace de atributo pode ser nulo.

localName - Nome local do atributo.

Retornos:

O valor da cadeia de caracteres para o atributo no elemento XML ou nulo se o atributo não existir.

getStringElement

public abstract String getStringElement()

Obtém o valor da cadeia de caracteres para o elemento atual.

Retornos:

O valor da cadeia de caracteres para o elemento atual.

Gera:

XMLStreamException

- Se o elemento String não puder ser lido.

nextElement

public abstract XmlToken nextElement()

Itera para e retorna o próximo START_ELEMENT ou END_ELEMENT no fluxo XML.

Retorna END_DOCUMENT se a iteração para o próximo token de elemento conclui a leitura do fluxo XML.

Retornos:

O próximo START_ELEMENT ou END_ELEMENT no fluxo XML ou END_DOCUMENT se a leitura for concluída.

Gera:

XMLStreamException

- Se o próximo elemento não puder ser determinado.

skipElement

public final void skipElement()

Ignora o elemento XML atual.

Se o currentToken() não for um START_ELEMENT , isso será uma operação não operacional.

Isso lê o fluxo XML até que a correspondência END_ELEMENT seja encontrada para o atual START_ELEMENT.

Gera:

XMLStreamException

- Se ignorar o elemento falhar.