Интерфейс 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, может вызвать исключение преобразования типов, если это событие не является 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()`	Функция проверки, является ли это событие объектом 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()

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

Возвращает:

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

См. также:

Location

isStartElement

boolean isStartElement()

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

Возвращает:

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

См. также:

StartElement

isAttribute

boolean isAttribute()

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

Возвращает:

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

См. также:

Attribute

isNamespace

boolean isNamespace()

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

Возвращает:

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

См. также:

Namespace

isEndElement

boolean isEndElement()

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

Возвращает:

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

См. также:

EndElement

isEntityReference

boolean isEntityReference()

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

Возвращает:

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

См. также:

EntityReference

isProcessingInstruction

boolean isProcessingInstruction()

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

Возвращает:

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

См. также:

ProcessingInstruction

isCharacters

boolean isCharacters()

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

Возвращает:

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

См. также:

Characters

isStartDocument

boolean isStartDocument()

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

Возвращает:

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

См. также:

StartDocument

isEndDocument

boolean isEndDocument()

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

Возвращает:

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

См. также:

EndDocument

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 как символы Unicode. Не должно выводиться никакое отступы или пробелы. Любой пользовательский тип события ДОЛЖЕН иметь этот метод вызываемым при записи в выходной поток. Встроенные типы событий ДОЛЖНЫ реализовывать этот метод, но реализации МОГУТ выбрать не вызывать эти методы по причинам оптимизации при записи встроенных событий в выходной поток. Выводимый результат ДОЛЖЕН быть эквивалентен по информации, выраженной в информационной модели.

Параметры:: writer - Пишущий объект, который будет выводить данные
Исключения:: XMLStreamException - если произошла фатальная ошибка при записи события

© 1993, 2021, 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/17/docs/api/java.xml/javax/xml/stream/events/XMLEvent.html