Интерфейс 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
Версия:: 1.0
См. также:: 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, может привести к исключению класса cast, если это событие не Characters.
`EndElement`	`asEndElement()` Возвращает это событие как событие закрытия элемента, может привести к исключению класса cast, если это событие не является событием закрытия элемента.
`StartElement`	`asStartElement()` Возвращает это событие как событие открытия элемента, может привести к исключению класса cast, если это событие не является событием открытия элемента.
`int`	`getEventType()` Возвращает целочисленный код для этого события.
`Location`	`getLocation()` Возвращает расположение этого события.
`QName`	`getSchemaType()` Этот метод предоставляется реализациям для предоставления необязательной информации о типе связанного события.
`boolean`	`isAttribute()` Вспомогательная функция для проверки, является ли это событие Attribute.
`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()

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

См. также:: 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.

См. также:: StartElement

isAttribute

boolean isAttribute()

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

См. также:: Attribute

isNamespace

boolean isNamespace()

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

См. также:: Namespace

isEndElement

boolean isEndElement()

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

См. также:: EndElement

isEntityReference

boolean isEntityReference()

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

См. также:: EntityReference

isProcessingInstruction

boolean isProcessingInstruction()

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

См. также:: ProcessingInstruction

isCharacters

boolean isCharacters()

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

См. также:: Characters

isStartDocument

boolean isStartDocument()

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

См. также:: StartDocument

isEndDocument

boolean isEndDocument()

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

См. также:: EndDocument

asStartElement

StartElement asStartElement()

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

asEndElement

EndElement asEndElement()

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

asCharacters

Characters asCharacters()

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

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.