Интерфейс StartDocument

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

public interface StartDocument extends XMLEvent

Интерфейс для события начала документа

Начиная с:: 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`	Указывает, что событие является началом элемента

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

Модификатор и тип	Метод	Описание
`boolean`	`encodingSet()`	Возвращает true, если CharacterEncodingScheme задана в объявлении кодировки документа
`String`	`getCharacterEncodingScheme()`	Возвращает стиль кодирования XML-данных
`String`	`getSystemId()`	Возвращает системный идентификатор XML-данных
`String`	`getVersion()`	Возвращает версию XML для этого потока XML
`boolean`	`isStandalone()`	Возвращает признак того, что этот XML является автономным
`boolean`	`standaloneSet()`	Возвращает true, если атрибут standalone задан в объявлении кодировки документа.

Методы, объявленные в интерфейсе 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()`	Вспомогательная функция для проверки, является ли это событие символьными данными.
`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.

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

getSystemId

String getSystemId()

Возвращает системный идентификатор XML-данных

Возвращает:: системный идентификатор; по умолчанию ""

getCharacterEncodingScheme

String getCharacterEncodingScheme()

Возвращает стиль кодирования XML-данных

Возвращает:: кодировку символов; по умолчанию "UTF-8"

encodingSet

boolean encodingSet()

Возвращает true, если CharacterEncodingScheme задана в объявлении кодировки документа

Возвращает:: true, если задано CharacterEncodingScheme; в противном случае false

isStandalone

boolean isStandalone()

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

Возвращает:: состояние автономности XML; по умолчанию "no"

standaloneSet

boolean standaloneSet()

Возвращает true, если атрибут standalone задан в объявлении кодировки документа.

Возвращает:: true, если атрибут standalone задан; в противном случае false

getVersion

String getVersion()

Возвращает версию XML для этого потока XML

Возвращает:: версию XML; по умолчанию "1.0"

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