Интерфейс Entity

Все суперинтерфейсы:: Node

public interface Entity extends Node

Этот интерфейс представляет известную сущность — разобранную или неразобранную — в XML-документе. Обратите внимание: он моделирует саму сущность, а не объявление сущности.

Атрибут nodeName, унаследованный от Node, содержит имя сущности.

XML-процессор может полностью раскрыть сущности до передачи модели структуры в DOM; в этом случае в дереве документа не будет узлов EntityReference.

XML не требует от XML-процессора без проверки читать и обрабатывать объявления сущностей, находящиеся во внешнем подмножестве или объявленные в параметрических сущностях. Это означает, что некоторые классы приложений могут не раскрывать разобранные сущности, объявленные во внешнем подмножестве, и что текст замены сущности может быть недоступен. Если текст замены доступен, список дочерних узлов соответствующего узла Entity представляет структуру этого текста замены. В противном случае список дочерних узлов пуст.

DOM Level 3 не поддерживает редактирование узлов Entity; если пользователь хочет изменить содержимое Entity, каждый связанный узел EntityReference в модели структуры необходимо заменить клоном содержимого Entity, после чего внести желаемые изменения в каждый из этих клонов. Узлы Entity и все их потомки доступны только для чтения.

Узел Entity не имеет родительского узла.

Примечание: Если сущность содержит несвязанный префикс пространства имён, значение namespaceURI соответствующего узла в поддереве узла Entity равно null. То же верно для узлов EntityReference, ссылающихся на эту сущность, если они созданы с помощью метода createEntityReference интерфейса Document.

См. также основную спецификацию объектной модели документа (DOM) Level 3.

Начиная с версии:: 1.4, DOM Level 2

Краткое описание полей

Поля, объявленные в интерфейсе Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Модификатор и тип	Поле	Описание
`static final short`	`ATTRIBUTE_NODE`	Узел является `Attr`.
`static final short`	`CDATA_SECTION_NODE`	Узел является `CDATASection`.
`static final short`	`COMMENT_NODE`	Узел является `Comment`.
`static final short`	`DOCUMENT_FRAGMENT_NODE`	Узел является `DocumentFragment`.
`static final short`	`DOCUMENT_NODE`	Узел является `Document`.
`static final short`	`DOCUMENT_POSITION_CONTAINED_BY`	Узел содержится в узле-ссылке.
`static final short`	`DOCUMENT_POSITION_CONTAINS`	Узел содержит узел-ссылку.
`static final short`	`DOCUMENT_POSITION_DISCONNECTED`	Узлы не связаны.
`static final short`	`DOCUMENT_POSITION_FOLLOWING`	Узел следует за узлом-ссылкой.
`static final short`	`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC`	Определение того, какой узел предшествует, а какой следует за другим, зависит от реализации.
`static final short`	`DOCUMENT_POSITION_PRECEDING`	Второй узел предшествует узлу-ссылке.
`static final short`	`DOCUMENT_TYPE_NODE`	Узел является `DocumentType`.
`static final short`	`ELEMENT_NODE`	Узел является `Element`.
`static final short`	`ENTITY_NODE`	Узел является `Entity`.
`static final short`	`ENTITY_REFERENCE_NODE`	Узел является `EntityReference`.
`static final short`	`NOTATION_NODE`	Узел является `Notation`.
`static final short`	`PROCESSING_INSTRUCTION_NODE`	Узел является `ProcessingInstruction`.
`static final short`	`TEXT_NODE`	Узел является узлом `Text`.

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

Модификатор и тип	Метод	Описание
`String`	`getInputEncoding()`	Атрибут, задающий кодировку, использованную для этой сущности во время разбора, если она является внешней разобранной сущностью.
`String`	`getNotationName()`	Для неразобранных сущностей — имя обозначения сущности.
`String`	`getPublicId()`	Идентификатор public, связанный с сущностью, если он указан, и `null` в противном случае.
`String`	`getSystemId()`	Идентификатор system, связанный с сущностью, если он указан, и `null` в противном случае.
`String`	`getXmlEncoding()`	Атрибут, задающий в составе текстового объявления кодировку этой сущности, если она является внешней разобранной сущностью.
`String`	`getXmlVersion()`	Атрибут, задающий в составе текстового объявления номер версии этой сущности, если она является внешней разобранной сущностью.

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

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Модификатор и тип	Метод	Описание
`Node`	`appendChild(Node newChild)`	Добавляет узел `newChild` в конец списка дочерних узлов этого узла.
`Node`	`cloneNode(boolean deep)`	Возвращает дубликат этого узла, то есть служит универсальным конструктором копирования узлов.
`short`	`compareDocumentPosition(Node other)`	Сравнивает узел-ссылку, то есть узел, для которого вызывается этот метод, с другим узлом, переданным в качестве параметра, по их положению в документе и в соответствии с порядком документа.
`NamedNodeMap`	`getAttributes()`	`NamedNodeMap`, содержащий атрибуты этого узла (если он является `Element`), или `null` в противном случае.
`String`	`getBaseURI()`	Абсолютный базовый URI этого узла или `null`, если реализации не удалось получить абсолютный URI.
`NodeList`	`getChildNodes()`	`NodeList`, содержащий все дочерние узлы этого узла.
`Object`	`getFeature(String feature, String version)`	Этот метод возвращает специализированный объект, реализующий специализированные API указанной функции и версии, как указано в .
`Node`	`getFirstChild()`	Первый дочерний узел этого узла.
`Node`	`getLastChild()`	Последний дочерний узел этого узла.
`String`	`getLocalName()`	Возвращает локальную часть квалифицированного имени этого узла.
`String`	`getNamespaceURI()`	URI пространства имён этого узла или `null`, если он не указан (см. ).
`Node`	`getNextSibling()`	Узел, непосредственно следующий за этим узлом.
`String`	`getNodeName()`	Имя этого узла в зависимости от его типа; см. таблицу выше.
`short`	`getNodeType()`	Код, представляющий тип базового объекта, как определено выше.
`String`	`getNodeValue()`	Значение этого узла в зависимости от его типа; см. таблицу выше.
`Document`	`getOwnerDocument()`	Объект `Document`, связанный с этим узлом.
`Node`	`getParentNode()`	Родительский узел этого узла.
`String`	`getPrefix()`	Префикс пространства имён этого узла или `null`, если он не указан.
`Node`	`getPreviousSibling()`	Узел, непосредственно предшествующий этому узлу.
`String`	`getTextContent()`	Этот атрибут возвращает текстовое содержимое этого узла и его потомков.
`Object`	`getUserData(String key)`	Получает объект, связанный с ключом в этом узле.
`boolean`	`hasAttributes()`	Возвращает, есть ли у этого узла атрибуты (если он является элементом).
`boolean`	`hasChildNodes()`	Возвращает, есть ли у этого узла дочерние узлы.
`Node`	`insertBefore(Node newChild, Node refChild)`	Вставляет узел `newChild` перед существующим дочерним узлом `refChild`.
`boolean`	`isDefaultNamespace(String namespaceURI)`	Этот метод проверяет, является ли указанный `namespaceURI` пространством имён по умолчанию.
`boolean`	`isEqualNode(Node arg)`	Проверяет, равны ли два узла.
`boolean`	`isSameNode(Node other)`	Возвращает, является ли этот узел тем же узлом, что и заданный.
`boolean`	`isSupported(String feature, String version)`	Проверяет, реализует ли реализация DOM определённую функцию и поддерживается ли эта функция данным узлом, как указано в .
`String`	`lookupNamespaceURI(String prefix)`	Ищет URI пространства имён, связанный с заданным префиксом, начиная с этого узла.
`String`	`lookupPrefix(String namespaceURI)`	Ищет префикс, связанный с заданным URI пространства имён, начиная с этого узла.
`void`	`normalize()`	Приводит все узлы `Text` на всей глубине поддерева этого `Node`, включая узлы атрибутов, к «нормальной» форме, в которой узлы `Text` разделяются только структурными элементами (например, элементами, комментариями, инструкциями обработки, секциями CDATA и ссылками на сущности), то есть отсутствуют соседние узлы `Text` и пустые узлы `Text`.
`Node`	`removeChild(Node oldChild)`	Удаляет дочерний узел, указанный в `oldChild`, из списка дочерних узлов и возвращает его.
`Node`	`replaceChild(Node newChild, Node oldChild)`	Заменяет дочерний узел `oldChild` на `newChild` в списке дочерних узлов и возвращает узел `oldChild`.
`void`	`setNodeValue(String nodeValue)`	Значение этого узла в зависимости от его типа; см. таблицу выше.
`void`	`setPrefix(String prefix)`	Префикс пространства имён этого узла или `null`, если он не указан.
`void`	`setTextContent(String textContent)`	Этот атрибут возвращает текстовое содержимое этого узла и его потомков.
`Object`	`setUserData(String key, Object data, UserDataHandler handler)`	Связывает объект с ключом в этом узле.

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

getPublicId

String getPublicId()

Публичный идентификатор, связанный с сущностью, если он указан, и null в противном случае.

getSystemId

String getSystemId()

Системный идентификатор, связанный с сущностью, если он указан, и null в противном случае. Он может быть абсолютным URI или нет.

getNotationName

String getNotationName()

Для неразобранных сущностей — имя нотации сущности. Для разобранных сущностей это null.

getInputEncoding

String getInputEncoding()

Атрибут, указывающий кодировку, использованную для этой сущности во время разбора, если она является внешней разобранной сущностью. Это null, если сущность взята из внутреннего подмножества или кодировка неизвестна.

С версии:: 1.5, DOM Level 3

getXmlEncoding

String getXmlEncoding()

Атрибут, указывающий в составе текстового объявления кодировку этой сущности, если она является внешней разобранной сущностью. В противном случае это null.

С версии:: 1.5, DOM Level 3

getXmlVersion

String getXmlVersion()

Атрибут, указывающий в составе текстового объявления номер версии этой сущности, если она является внешней разобранной сущностью. В противном случае это null.

С версии:: 1.5, DOM Level 3

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