XmlReader Clase

Paquete:

com.azure.xml

Artefacto Maven:

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

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

Implementaciones

Autocloseable

public abstract class XmlReader
implements AutoCloseable

Lee un valor codificado XML como un flujo de tokens.

Resumen del constructor

Constructor	Description
XmlReader()	Crea una instancia de XmlReader.

Resumen del método

Modificador y tipo	Método y descripción
final T	getNullableAttribute(String namespaceUri, String localName, ReadValueCallback<String,T> converter) Obtiene el valor que acepta valores NULL para el atributo en el elemento XML.
final T	getNullableElement(ReadValueCallback<String,T> converter) Obtiene el valor que acepta valores NULL para el elemento actual.
final T	readObject(String localName, ReadValueCallback<XmlReader,T> converter) Lee un objeto de la secuencia XML.
final T	readObject(String namespaceUri, String localName, ReadValueCallback<XmlReader,T> converter) Lee un objeto de la secuencia XML.
abstract void	close() Cierra la secuencia XML.
abstract XmlToken	currentToken() Obtiene el XmlToken objeto al que apunta el lector actualmente.
final byte[]	getBinaryAttribute(String namespaceUri, String localName) Obtiene el valor binario del atributo en el elemento XML.
final byte[]	getBinaryElement() Obtiene el valor binario del elemento actual.
final boolean	getBooleanAttribute(String namespaceUri, String localName) Obtiene el valor booleano del atributo en el elemento XML.
final boolean	getBooleanElement() Obtiene el valor booleano del elemento actual.
final double	getDoubleAttribute(String namespaceUri, String localName) Obtiene el valor doble del atributo en el elemento XML.
final double	getDoubleElement() Obtiene el valor doble del elemento actual.
abstract QName	getElementName() Obtiene para QName el elemento XML actual.
final float	getFloatAttribute(String namespaceUri, String localName) Obtiene el valor float del atributo en el elemento XML.
final float	getFloatElement() Obtiene el valor float del elemento actual.
final int	getIntAttribute(String namespaceUri, String localName) Obtiene el valor int del atributo en el elemento XML.
final int	getIntElement() Obtiene el valor int del elemento actual.
final long	getLongAttribute(String namespaceUri, String localName) Obtiene el valor long del atributo en el elemento XML.
final long	getLongElement() Obtiene el valor long del elemento actual.
abstract String	getStringAttribute(String namespaceUri, String localName) Obtiene el valor de cadena para el atributo en el elemento XML.
abstract String	getStringElement() Obtiene el valor de cadena del elemento actual.
abstract XmlToken	nextElement() Recorre en iteración y devuelve el siguiente START_ELEMENT o END_ELEMENT en la secuencia XML.
final void	skipElement() Omite el elemento XML actual.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

XmlReader

public XmlReader()

Crea una instancia de XmlReader.

Detalles del método

getNullableAttribute

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

Obtiene el valor que acepta valores NULL para el atributo en el elemento XML.

Si el atributo no tiene un valor o no existe null se devolverá, de lo contrario, el atributo getStringAttribute(String namespaceUri, String localName) se pasa al convertidor.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

converter - Función que convierte el valor de texto del atributo en el tipo que acepta valores NULL.

Devoluciones:

Valor de texto convertido, o null si el atributo no tenía un valor.

Produce:

XMLStreamException

- Si no se puede leer el atributo que acepta valores NULL.

getNullableElement

public final T getNullableElement(ReadValueCallback converter)

Obtiene el valor que acepta valores NULL para el elemento actual.

Si el elemento actual no tiene un valor NULL se devolverá, de lo contrario, el elemento getStringElement() se pasa al convertidor.

Parámetros:

converter - Función que convierte el valor de texto del elemento en el tipo que acepta valores NULL.

Devoluciones:

Valor de texto convertido, o null si el elemento no tenía un valor.

Produce:

XMLStreamException

- Si no se puede leer el elemento que acepta valores NULL.

readObject

public final T readObject(String localName, ReadValueCallback converter)

Lee un objeto de la secuencia XML.

Valida que XmlReader está apuntando actualmente a un START_ELEMENT objeto que tiene el nombre calificado especificado por .startTagName

Parámetros:

localName - El nombre local inicial esperado para el objeto .

converter - Función que lee el objeto .

Devoluciones:

Instancia del objeto esperado,

Produce:

XMLStreamException

- Si la etiqueta inicial no XmlToken#START_ELEMENT es o la etiqueta no coincide con el esperado startTagName

readObject

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

Lee un objeto de la secuencia XML.

Valida que XmlReader está apuntando actualmente a un START_ELEMENT objeto que tiene el nombre calificado especificado por .startTagName

Parámetros:

namespaceUri - Espacio de nombres esperado para el objeto .

localName - El nombre local inicial esperado para el objeto .

converter - Función que lee el objeto .

Devoluciones:

Instancia del objeto esperado,

Produce:

XMLStreamException

- Si la etiqueta inicial no XmlToken#START_ELEMENT es o la etiqueta no coincide con el esperado startTagName

close

public abstract void close()

Cierra la secuencia XML.

Produce:

XMLStreamException

- Si el almacén de contenido subyacente no se cierra.

currentToken

public abstract XmlToken currentToken()

Obtiene el XmlToken objeto al que apunta el lector actualmente.

Devuelve START_DOCUMENT si el lector no ha empezado a leer la secuencia XML. Devuelve END_DOCUMENT si el lector ha completado la lectura de la secuencia XML.

Devoluciones:

al XmlToken que apunta el lector actualmente.

getBinaryAttribute

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

Obtiene el valor binario del atributo en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor binario del atributo en el elemento XML.

getBinaryElement

public final byte[] getBinaryElement()

Obtiene el valor binario del elemento actual.

Devoluciones:

Valor binario del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento binario.

getBooleanAttribute

public final boolean getBooleanAttribute(String namespaceUri, String localName)

Obtiene el valor booleano del atributo en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor booleano del atributo en el elemento XML.

getBooleanElement

public final boolean getBooleanElement()

Obtiene el valor booleano del elemento actual.

Devoluciones:

Valor booleano del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento booleano.

getDoubleAttribute

public final double getDoubleAttribute(String namespaceUri, String localName)

Obtiene el valor doble del atributo en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor doble del atributo en el elemento XML.

getDoubleElement

public final double getDoubleElement()

Obtiene el valor doble del elemento actual.

Devoluciones:

Valor doble del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento double.

getElementName

public abstract QName getElementName()

Obtiene para QName el elemento XML actual.

Devoluciones:

QName para el elemento XML actual.

getFloatAttribute

public final float getFloatAttribute(String namespaceUri, String localName)

Obtiene el valor float del atributo en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor float del atributo en el elemento XML.

getFloatElement

public final float getFloatElement()

Obtiene el valor float del elemento actual.

Devoluciones:

Valor float del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento float.

getIntAttribute

public final int getIntAttribute(String namespaceUri, String localName)

Obtiene el valor int del atributo en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor int del atributo en el elemento XML.

getIntElement

public final int getIntElement()

Obtiene el valor int del elemento actual.

Devoluciones:

Valor int del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento int.

getLongAttribute

public final long getLongAttribute(String namespaceUri, String localName)

Obtiene el valor long del atributo en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor long del atributo en el elemento XML.

getLongElement

public final long getLongElement()

Obtiene el valor long del elemento actual.

Devoluciones:

Valor long del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento long.

getStringAttribute

public abstract String getStringAttribute(String namespaceUri, String localName)

Obtiene el valor de cadena para el atributo en el elemento XML.

Se devuelve null si el atributo no existe en el elemento XML.

Parámetros:

namespaceUri - El espacio de nombres del atributo puede ser NULL.

localName - Nombre local del atributo.

Devoluciones:

Valor de cadena para el atributo en el elemento XML o null si el atributo no existe.

getStringElement

public abstract String getStringElement()

Obtiene el valor de cadena del elemento actual.

Devoluciones:

Valor de cadena del elemento actual.

Produce:

XMLStreamException

- Si no se puede leer el elemento String.

nextElement

public abstract XmlToken nextElement()

Recorre en iteración y devuelve el siguiente START_ELEMENT o END_ELEMENT en la secuencia XML.

Devuelve END_DOCUMENT si la iteración del token de elemento siguiente completa la lectura de la secuencia XML.

Devoluciones:

START_ELEMENT Siguiente o END_ELEMENT en la secuencia XML, o END_DOCUMENT si se completa la lectura.

Produce:

XMLStreamException

- Si no se puede determinar el siguiente elemento.

skipElement

public final void skipElement()

Omite el elemento XML actual.

currentToken() Si no es una START_ELEMENT operación no operativa.

Esto lee la secuencia XML hasta que se encuentra la coincidencia END_ELEMENT para el objeto actual START_ELEMENT.

Produce:

XMLStreamException

- Si se omite el elemento, se produce un error.