Интерфейс XMLEventReader

Все суперинтерфейсы:: Iterator<Object>

Все известные реализующие классы:: EventReaderDelegate

public interface XMLEventReader extends Iterator<Object>

Это интерфейс верхнего уровня для парсинга событий XML. Он предоставляет возможность предварительного просмотра следующего события и возвращает информацию о конфигурации через интерфейс свойств.

С тех пор:

1.6

См. также:

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`close()`	Освобождает все ресурсы, связанные с этим читателем.
`String`	`getElementText()`	Считывает содержимое элемента только с текстом.
`Object`	`getProperty(String name)`	Получение значения свойства/характеристики из базовой реализации.
`boolean`	`hasNext()`	Проверка наличия дополнительных событий.
`XMLEvent`	`nextEvent()`	Получение следующего события XMLEvent.
`XMLEvent`	`nextTag()`	Пропускает все несущественные пробельные события до достижения START_ELEMENT или END_ELEMENT.
`XMLEvent`	`peek()`	Проверка следующего события XMLEvent без его чтения из потока.

Методы, объявленные в интерфейсе java.util.Iterator

forEachRemaining, next, remove

Подробное описание методов

nextEvent

XMLEvent nextEvent() throws XMLStreamException

Получение следующего события XMLEvent. Начальное событие - StartDocument.

Возвращает:

следующее событие XMLEvent

Исключения:

XMLStreamException - если возникла ошибка в базовом XML.

NoSuchElementException - итерация завершена.

См. также:

XMLEvent

hasNext

boolean hasNext()

Проверка наличия дополнительных событий. Возвращает true, если есть дополнительные события, и false в противном случае.

Определено в:: hasNext в интерфейсе Iterator<Object>
Возвращает:: true, если в читателе событий есть дополнительные события, иначе false

peek

XMLEvent peek() throws XMLStreamException

Проверка следующего события XMLEvent без его чтения из потока. Возвращает null, если поток находится в конце файла (EOF) или больше нет XMLEvents. Вызов peek() будет эквивалентен следующему возврату next().

Возвращает:

следующее событие XMLEvent

Исключения:

XMLStreamException - если произошла ошибка

См. также:

XMLEvent

getElementText

String getElementText() throws XMLStreamException

Считывает содержимое элемента, содержащего только текст. Предпосылка: текущее событие — START_ELEMENT. Последовательность действий: Текущее событие — соответствующее END_ELEMENT.

Возвращает:: текст элемента
Исключения:: XMLStreamException - если текущее событие не является START_ELEMENT или если обнаружен элемент, не содержащий текст

nextTag

XMLEvent nextTag() throws XMLStreamException

Пропускает все несущественные пробельные события до достижения START_ELEMENT или END_ELEMENT. Если обнаруживается что-либо отличное от пробельных символов, выбрасывается исключение. Этот метод следует использовать при обработке содержимого только элементов, так как анализатор не может распознать игнорируемые пробелы, если DTD отсутствует или не интерпретируется.

Возвращает:: START_ELEMENT или END_ELEMENT
Исключения:: XMLStreamException - если обнаруживается что-либо отличное от пробельных символов

getProperty

Object getProperty(String name) throws IllegalArgumentException

Получение значения свойства/характеристики из базовой реализации

Параметры:: name - Имя свойства
Возвращает:: Значение свойства
Исключения:: IllegalArgumentException - если свойство не поддерживается

close

void close() throws XMLStreamException

Освобождает все ресурсы, связанные с этим читателем. Этот метод не закрывает базовый источник ввода.

Исключения:: XMLStreamException - если возникли ошибки при освобождении связанных ресурсов

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.xml/javax/xml/stream/XMLEventReader.html