Интерфейс XMLEventReader
- Все суперинтерфейсы:
Iterator<Object>
- Все известные реализующие классы:
EventReaderDelegate
public interface XMLEventReader extends Iterator<Object>
Это интерфейс верхнего уровня для разбора XML-событий. Он позволяет просмотреть следующее событие и получать сведения о конфигурации через интерфейс свойств.
- Начиная с версии:
- 1.6
- См. также:
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
close() |
Освобождает все ресурсы, связанные с этим средством чтения. |
String |
getElementText() |
Читает содержимое элемента, содержащего только текст. |
Object |
getProperty |
Получает значение функции или свойства из базовой реализации. |
boolean |
hasNext() |
Проверяет, есть ли ещё события. |
XMLEvent |
nextEvent() |
Получает следующее XMLEvent. |
XMLEvent |
nextTag() |
Пропускает незначащие события пробельных символов, пока не будет достигнут START_ELEMENT или END_ELEMENT. |
XMLEvent |
peek() |
Проверяет следующее XMLEvent, не считывая его из потока. |
Методы, объявленные в интерфейсе Iterator
forEachRemaining, next, remove | Модификатор и тип | Метод | Описание |
|---|---|---|
default void |
forEachRemaining |
Выполняет указанное действие для каждого оставшегося элемента, пока не будут обработаны все элементы или действие не вызовет исключение. |
Object |
next() |
Возвращает следующий элемент в итерации. |
default void |
remove() |
Удаляет из базовой коллекции последний элемент, возвращённый этим итератором (необязательная операция). |
Подробное описание методов
nextEvent
XMLEvent nextEvent() throws XMLStreamException
Получает следующее XMLEvent. Начальное событие —
StartDocument.- Возвращает:
- следующее XMLEvent
- Вызывает:
-
XMLStreamException— если произошла ошибка в базовом XML. -
NoSuchElementException— если в итерации больше нет элементов. - См. также:
hasNext
peek
XMLEvent peek() throws XMLStreamException
Проверяет следующее XMLEvent, не считывая его из потока. Возвращает null, если поток достиг EOF или в нём больше нет XMLEvent. Вызов 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, 2025, 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.
