Интерфейс 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 - итерация не имеет больше элементов.

См. также:

hasNext

boolean hasNext()

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

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

peek

XMLEvent peek() throws XMLStreamException

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

Возвращает:

следующее XMLEvent

Исключение:

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

См. также:

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, 2023, 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/21/docs/api/java.xml/javax/xml/stream/XMLEventReader.html