Интерфейс XMLEvent

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

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

public interface XMLEvent extends XMLStreamConstants

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

С момента:

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, может вызвать исключение class cast, если это событие не Characters.
`EndElement`	`asEndElement()`	Возвращает это событие как событие завершения элемента, может вызвать исключение class cast, если это событие не событие завершения элемента.
`StartElement`	`asStartElement()`	Возвращает это событие как событие начала элемента, может вызвать исключение class cast, если это событие не событие начала элемента.
`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()

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

Возвращает:

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

См. также:

isAttribute

boolean isAttribute()

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

Возвращает:

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

См. также:

isNamespace

boolean isNamespace()

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

Возвращает:

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

См. также:

isEndElement

boolean isEndElement()

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

Возвращает:

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

См. также:

isEntityReference

boolean isEntityReference()

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

Возвращает:

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

См. также:

isProcessingInstruction

boolean isProcessingInstruction()

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

Возвращает:

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

См. также:

isCharacters

boolean isCharacters()

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

Возвращает:

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

См. также:

isStartDocument

boolean isStartDocument()

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

Возвращает:

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

См. также:

isEndDocument

boolean isEndDocument()

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

Возвращает:

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

См. также:

asStartElement

StartElement asStartElement()

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

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

asEndElement

EndElement asEndElement()

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

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

asCharacters

Characters asCharacters()

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

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

getSchemaType

QName getSchemaType()

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

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

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer) throws XMLStreamException

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

Параметры:: writer - Поток вывода, который будет выводить данные
Исключение:: 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/events/XMLEvent.html