Интерфейс XMLEvent

Все суперинтерфейсы:: XMLStreamConstants

Все известные дочерние интерфейсы:: Attribute, Characters, Comment, DTD, EndDocument, EndElement, EntityDeclaration, EntityReference, Namespace, NotationDeclaration, ProcessingInstruction, StartDocument, StartElement

public interface XMLEvent extends XMLStreamConstants

Это базовый интерфейс событий для обработки событий разметки. События — это объекты-значения, используемые для передачи набора данных XML 1.0 в приложение. События могут быть кэшированы и использованы после завершения парсинга.

С момента:

1.6

См. также:

Краткое описание полей

Поля, объявленные в интерфейсе javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

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

Модификатор и тип	Метод	Описание
`Characters`	`asCharacters()`	Возвращает это событие как Characters, может привести к исключению ClassCastException, если это событие не Characters.
`EndElement`	`asEndElement()`	Возвращает это событие как событие закрытия элемента, может привести к исключению ClassCastException, если это событие не является событием закрытия элемента.
`StartElement`	`asStartElement()`	Возвращает это событие как событие начала элемента, может привести к исключению ClassCastException, если это событие не является событием начала элемента.
`int`	`getEventType()`	Возвращает целочисленный код для этого события.
`Location`	`getLocation()`	Возвращает местоположение этого события.
`QName`	`getSchemaType()`	Этот метод предоставляется реализациям для предоставления необязательной информации о типе связанного события.
`boolean`	`isAttribute()`	Утилитарная функция для проверки, является ли это событие атрибутом.
`boolean`	`isCharacters()`	Утилитарная функция для проверки, является ли это событие Characters.
`boolean`	`isEndDocument()`	Утилитарная функция для проверки, является ли это событие EndDocument.
`boolean`	`isEndElement()`	Утилитарная функция для проверки, является ли это событие EndElement.
`boolean`	`isEntityReference()`	Утилитарная функция для проверки, является ли это событие EntityReference.
`boolean`	`isNamespace()`	Утилитарная функция для проверки, является ли это событие Namespace.
`boolean`	`isProcessingInstruction()`	Утилитарная функция для проверки, является ли это событие ProcessingInstruction.
`boolean`	`isStartDocument()`	Утилитарная функция для проверки, является ли это событие StartDocument.
`boolean`	`isStartElement()`	Утилитарная функция для проверки, является ли это событие StartElement.
`void`	`writeAsEncodedUnicode(Writer writer)`	Этот метод запишет XMLEvent в соответствии со спецификацией XML 1.0 в виде символов Unicode.

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

getEventType

int getEventType()

Возвращает целовый код для данного события.

Возвращает:

тип события

См. также:

getLocation

Location getLocation()

Возвращает расположение данного события. Расположение, возвращаемое этим методом, является неизменным и сохранит свою информацию.

Возвращает:

расположение события

См. также:

isStartElement

boolean isStartElement()

Вспомогательная функция для проверки, является ли это событие StartElement.

Возвращает:

true, если событие является StartElement, иначе false

См. также:

isAttribute

boolean isAttribute()

Вспомогательная функция для проверки, является ли это событие Attribute.

Возвращает:

true, если событие является Attribute, иначе false

См. также:

isNamespace

boolean isNamespace()

Вспомогательная функция для проверки, является ли это событие Namespace.

Возвращает:

true, если событие является Namespace, иначе false

См. также:

isEndElement

boolean isEndElement()

Вспомогательная функция для проверки, является ли это событие EndElement.

Возвращает:

true, если событие является EndElement, иначе false

См. также:

isEntityReference

boolean isEntityReference()

Вспомогательная функция для проверки, является ли это событие EntityReference.

Возвращает:

true, если событие является EntityReference, иначе false

См. также:

isProcessingInstruction

boolean isProcessingInstruction()

Вспомогательная функция для проверки, является ли это событие ProcessingInstruction.

Возвращает:

true, если событие является ProcessingInstruction, иначе false

См. также:

isCharacters

boolean isCharacters()

Вспомогательная функция для проверки, является ли это событие Characters.

Возвращает:

true, если событие является Characters, иначе false

См. также:

isStartDocument

boolean isStartDocument()

Вспомогательная функция для проверки, является ли это событие StartDocument.

Возвращает:

true, если событие является StartDocument, иначе false

См. также:

isEndDocument

boolean isEndDocument()

Вспомогательная функция для проверки, является ли это событие EndDocument.

Возвращает:

true, если событие является EndDocument, иначе false

См. также:

asStartElement

StartElement asStartElement()

Возвращает это событие как событие начала элемента, может привести к исключению ClassCastException, если это событие не является событием начала элемента.

Возвращает:: событие StartElement

asEndElement

EndElement asEndElement()

Возвращает это событие как событие конца элемента, может привести к исключению ClassCastException, если это событие не является событием конца элемента.

Возвращает:: событие EndElement

asCharacters

Characters asCharacters()

Возвращает это событие как Characters, может привести к исключению ClassCastException, если это событие не является Characters.

Возвращает:: событие Characters

getSchemaType

QName getSchemaType()

Этот метод предоставляется для реализации, чтобы предоставить необязательную информацию о типе связанного события. Он является необязательным и вернет null, если информация недоступна.

Возвращает:: тип события, null если недоступен

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer) throws XMLStreamException

Этот метод запишет XMLEvent в соответствии со спецификацией XML 1.0 как символы Юникода. Никакие отступы или пробелы не должны выводиться. Любой пользовательский тип события ДОЛЖЕН вызывать этот метод при записи в поток вывода. Встроенные типы событий ОБЯЗАТЕЛЬНО должны реализовывать этот метод, но реализации МОГУТ выбрать не вызывать эти методы по соображениям оптимизации при записи встроенных событий в поток вывода. Выводимый результат ДОЛЖЕН быть эквивалентен с точки зрения выражаемого информационного набора.

Параметры:: writer - Поток вывода, в который будут записаны данные
Исключения:: 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.
https://download.java.net/java/early_access/jdk24/docs/api/java.xml/javax/xml/stream/events/XMLEvent.html