Интерфейс 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
См. также:: XMLEventReader, Characters, ProcessingInstruction, StartElement, EndElement, StartDocument, EndDocument, EntityReference, EntityDeclaration, NotationDeclaration

Поля

Поля, объявленные в интерфейсе 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()`	Функция-утилита для проверки, является ли это событие событием закрытия документа.
`boolean`	`isEndElement()`	Функция-утилита для проверки, является ли это событие событием закрытия элемента.
`boolean`	`isEntityReference()`	Функция-утилита для проверки, является ли это событие ссылкой на сущность.
`boolean`	`isNamespace()`	Функция-утилита для проверки, является ли это событие пространством имен.
`boolean`	`isProcessingInstruction()`	Функция-утилита для проверки, является ли это событие инструкцией обработки.
`boolean`	`isStartDocument()`	Функция-утилита для проверки, является ли это событие событием открытия документа.
`boolean`	`isStartElement()`	Функция-утилита для проверки, является ли это событие событием открытия элемента.
`void`	`writeAsEncodedUnicode(Writer writer)`	Этот метод запишет XMLEvent в соответствии со спецификацией XML 1.0 как символы Юникод.

Методы

getEventType

int getEventType()

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

См. также:: XMLStreamConstants.START_ELEMENT, XMLStreamConstants.END_ELEMENT, XMLStreamConstants.CHARACTERS, XMLStreamConstants.ATTRIBUTE, XMLStreamConstants.NAMESPACE, XMLStreamConstants.PROCESSING_INSTRUCTION, XMLStreamConstants.COMMENT, XMLStreamConstants.START_DOCUMENT, XMLStreamConstants.END_DOCUMENT, XMLStreamConstants.DTD

getLocation

Location getLocation()

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

См. также:: Location

isStartElement

boolean isStartElement()

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

См. также:: StartElement

isAttribute

boolean isAttribute()

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

См. также:: Attribute

isNamespace

boolean isNamespace()

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

См. также:: Namespace

isEndElement

boolean isEndElement()

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

См. также:: EndElement

isEntityReference

boolean isEntityReference()

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

См. также:: EntityReference

isProcessingInstruction

boolean isProcessingInstruction()

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

См. также:: ProcessingInstruction

isCharacters

boolean isCharacters()

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

См. также:: Characters

isStartDocument

boolean isStartDocument()

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

См. также:: StartDocument

isEndDocument

boolean isEndDocument()

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

См. также:: EndDocument

asStartElement

StartElement asStartElement()

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

asEndElement

EndElement asEndElement()

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

asCharacters

Characters asCharacters()

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

getSchemaType

QName getSchemaType()

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

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer)
                    throws XMLStreamException

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

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

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