Интерфейс StartElement

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

public interface StartElement extends XMLEvent

Интерфейс StartElement предоставляет доступ к информации об элементах начала. Для каждого тега начала в документе генерируется событие StartElement.

Начиная с версии:: 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

Модификатор и тип	Поле	Описание
`static final int`	`ATTRIBUTE`	Указывает, что событие является атрибутом
`static final int`	`CDATA`	Указывает, что событие является секцией CDATA
`static final int`	`CHARACTERS`	Указывает, что событие содержит символы
`static final int`	`COMMENT`	Указывает, что событие является комментарием
`static final int`	`DTD`	Указывает, что событие является DTD
`static final int`	`END_DOCUMENT`	Указывает, что событие является концом документа
`static final int`	`END_ELEMENT`	Указывает, что событие является концом элемента
`static final int`	`ENTITY_DECLARATION`	Указывает на объявление сущности
`static final int`	`ENTITY_REFERENCE`	Указывает, что событие является ссылкой на сущность
`static final int`	`NAMESPACE`	Указывает, что событие является объявлением пространства имён
`static final int`	`NOTATION_DECLARATION`	Указывает на объявление нотации
`static final int`	`PROCESSING_INSTRUCTION`	Указывает, что событие является инструкцией обработки
`static final int`	`SPACE`	Символы являются пробельными символами (см. [XML], 2.10 «Обработка пробельных символов»).
`static final int`	`START_DOCUMENT`	Указывает, что событие является началом документа
`static final int`	`START_ELEMENT`	Указывает, что событие является началом элемента

Краткое описание методов

Модификатор и тип	Метод	Описание
`Attribute`	`getAttributeByName(QName name)`	Возвращает атрибут, указанный в qname.
`Iterator<Attribute>`	`getAttributes()`	Возвращает Iterator атрибутов, не являющихся пространствами имён, объявленных в этом START_ELEMENT.
`QName`	`getName()`	Возвращает имя этого события
`NamespaceContext`	`getNamespaceContext()`	Возвращает доступный только для чтения контекст пространств имён.
`Iterator<Namespace>`	`getNamespaces()`	Возвращает Iterator пространств имён, объявленных в этом элементе.
`String`	`getNamespaceURI(String prefix)`	Возвращает значение, с которым префикс связан в контексте этого элемента.

Методы, объявленные в интерфейсе XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Модификатор и тип	Метод	Описание
`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 в виде символов Unicode в соответствии со спецификацией XML 1.0.

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

getName

QName getName()

Возвращает имя этого события

Возвращает:: квалифицированное имя этого события

getAttributes

Iterator<Attribute> getAttributes()

Возвращает Iterator атрибутов, не являющихся пространствами имён, объявленных в этом START_ELEMENT. Если атрибутов нет, возвращает пустой итератор. Итератор должен содержать только реализации интерфейса Attribute. Порядок атрибутов не определён, поэтому они могут возвращаться в любом порядке.

Возвращает:: доступный только для чтения Iterator интерфейсов Attribute или пустой итератор

getNamespaces

Iterator<Namespace> getNamespaces()

Возвращает Iterator пространств имён, объявленных в этом элементе. Этот Iterator не содержит ранее объявленные пространства имён, если они не указаны в текущем START_ELEMENT. Поэтому этот список может содержать повторно объявленные пространства имён и дублирующиеся объявления пространств имён. Чтобы получить текущий контекст объявлений пространств имён, используйте метод getNamespaceContext().

Итератор должен содержать только реализации интерфейса Namespace.

Namespace является Attribute. Список пространств имён можно перебирать как список атрибутов. Однако этот метод возвращает только список пространств имён, объявленных в этом START_ELEMENT, и не включает атрибуты, объявленные в этом START_ELEMENT. Если пространств имён нет, возвращает пустой итератор.

Возвращает:: доступный только для чтения Iterator интерфейсов Namespace или пустой итератор

getAttributeByName

Attribute getAttributeByName(QName name)

Возвращает атрибут, указанный в qname.

Параметры:: name - qname искомого атрибута
Возвращает:: атрибут, соответствующий значению имени, или null

getNamespaceContext

NamespaceContext getNamespaceContext()

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

Возвращает:: текущий контекст пространств имён

getNamespaceURI

String getNamespaceURI(String prefix)

Возвращает значение, с которым префикс связан в контексте этого элемента. Если префикс не связан в этом контексте, возвращает null.

Параметры:: prefix - префикс для поиска
Возвращает:: URI, связанный с префиксом, или null

© 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.