Интерфейс 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

См. также:

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

Поля, объявленные в интерфейсе 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; если это событие не является Characters, может возникнуть исключение приведения типа.
`EndElement`	`asEndElement()`	Возвращает это событие как событие закрывающего элемента; если это событие не является закрывающим элементом, может возникнуть исключение приведения типа.
`StartElement`	`asStartElement()`	Возвращает это событие как событие открывающего элемента; если это событие не является открывающим элементом, может возникнуть исключение приведения типа.
`int`	`getEventType()`	Возвращает целочисленный код этого события.
`Location`	`getLocation()`	Возвращает местоположение этого события.
`QName`	`getSchemaType()`	Этот метод предоставляется для того, чтобы реализации могли указывать дополнительные сведения о типе связанного события.
`boolean`	`isAttribute()`	Вспомогательная функция для проверки, является ли это событие атрибутом.
`boolean`	`isCharacters()`	Вспомогательная функция для проверки, является ли это событие Characters.
`boolean`	`isEndDocument()`	Вспомогательная функция для проверки, является ли это событие EndDocument.
`boolean`	`isEndElement()`	Вспомогательная функция для проверки, является ли это событие EndElement.
`boolean`	`isEntityReference()`	Вспомогательная функция для проверки, является ли это событие EntityReference.
`boolean`	`isNamespace()`	Вспомогательная функция для проверки, является ли это событие пространством имён.
`boolean`	`isProcessingInstruction()`	Вспомогательная функция для проверки, является ли это событие ProcessingInstruction.
`boolean`	`isStartDocument()`	Вспомогательная функция для проверки, является ли это событие StartDocument.
`boolean`	`isStartElement()`	Вспомогательная функция для проверки, является ли это событие StartElement.
`void`	`writeAsEncodedUnicode(Writer writer)`	Этот метод записывает XMLEvent в виде символов Unicode в соответствии со спецификацией XML 1.0.

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

getEventType

int getEventType()

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

Возвращает:

тип события

См. также:

getLocation

Location getLocation()

Возвращает местоположение этого события. Объект Location, возвращаемый этим методом, является неизменяемым и сохраняет свои данные.

Возвращает:

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

См. также:

isStartElement

boolean isStartElement()

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

Возвращает:

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

См. также:

isAttribute

boolean isAttribute()

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

Возвращает:

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

См. также:

isNamespace

boolean isNamespace()

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

Возвращает:

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()

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

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

asEndElement

EndElement asEndElement()

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

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

asCharacters

Characters asCharacters()

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

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

getSchemaType

QName getSchemaType()

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

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

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer) throws XMLStreamException

Этот метод записывает XMLEvent в виде символов Unicode в соответствии со спецификацией 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://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/stream/events/XMLEvent.html