Интерфейс Document

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

Все известные подинтерфейсы:: HTMLDocument

public interface Document extends Node

Интерфейс Document представляет весь документ HTML или XML. Концептуально он является корнем дерева документа и обеспечивает основной доступ к данным документа.

Поскольку элементы, текстовые узлы, комментарии, инструкции по обработке и т. д. не могут существовать вне контекста Document, интерфейс Document также содержит фабричные методы, необходимые для создания этих объектов. Созданные объекты Node имеют атрибут ownerDocument, связывающий их с Document, в контексте которого они были созданы.

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

Начиная с:: 1.4, DOM уровня 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`.

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

Модификатор и тип	Метод	Описание
`Node`	`adoptNode(Node source)`	Пытается принять узел из другого документа в этот документ.
`Attr`	`createAttribute(String name)`	Создает `Attr` с указанным именем.
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName)`	Создает атрибут с указанным квалифицированным именем и URI пространства имен.
`CDATASection`	`createCDATASection(String data)`	Создает узел `CDATASection`, значением которого является указанная строка.
`Comment`	`createComment(String data)`	Создает узел `Comment` с указанной строкой.
`DocumentFragment`	`createDocumentFragment()`	Создает пустой объект `DocumentFragment`.
`Element`	`createElement(String tagName)`	Создает элемент указанного типа.
`Element`	`createElementNS(String namespaceURI, String qualifiedName)`	Создает элемент с указанным квалифицированным именем и URI пространства имен.
`EntityReference`	`createEntityReference(String name)`	Создает объект `EntityReference`.
`ProcessingInstruction`	`createProcessingInstruction(String target, String data)`	Создает узел `ProcessingInstruction` с указанными строками имени и данных.
`Text`	`createTextNode(String data)`	Создает узел `Text` с указанной строкой.
`DocumentType`	`getDoctype()`	Объявление типа документа (см. `DocumentType`), связанное с этим документом.
`Element`	`getDocumentElement()`	Этот вспомогательный атрибут обеспечивает прямой доступ к дочернему узлу, являющемуся элементом документа.
`String`	`getDocumentURI()`	Местоположение документа или `null`, если оно не определено или если `Document` был создан с помощью `DOMImplementation.createDocument`.
`DOMConfiguration`	`getDomConfig()`	Конфигурация, используемая при вызове `Document.normalizeDocument()`.
`Element`	`getElementById(String elementId)`	Возвращает `Element`, имеющий атрибут ID с указанным значением.
`NodeList`	`getElementsByTagName(String tagname)`	Возвращает `NodeList` всех `Elements` в порядке документа, имеющих указанное имя тега и содержащихся в документе.
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)`	Возвращает `NodeList` всех `Elements` с указанным локальным именем и URI пространства имен в порядке документа.
`DOMImplementation`	`getImplementation()`	Объект `DOMImplementation`, обрабатывающий этот документ.
`String`	`getInputEncoding()`	Атрибут, задающий кодировку, использованную для этого документа во время разбора.
`boolean`	`getStrictErrorChecking()`	Атрибут, указывающий, включена ли проверка ошибок.
`String`	`getXmlEncoding()`	Атрибут, задающий в составе объявления XML кодировку этого документа.
`boolean`	`getXmlStandalone()`	Атрибут, указывающий в составе объявления XML, является ли этот документ автономным.
`String`	`getXmlVersion()`	Атрибут, задающий в составе объявления XML номер версии этого документа.
`Node`	`importNode(Node importedNode, boolean deep)`	Импортирует узел из другого документа в этот документ, не изменяя и не удаляя исходный узел из оригинального документа; этот метод создает новую копию исходного узла.
`void`	`normalizeDocument()`	Этот метод действует так, как если бы документ прошел цикл сохранения и загрузки, приводя его к «нормальной» форме.
`Node`	`renameNode(Node n, String namespaceURI, String qualifiedName)`	Переименовывает существующий узел типа `ELEMENT_NODE` или `ATTRIBUTE_NODE`.
`void`	`setDocumentURI(String documentURI)`	Местоположение документа или `null`, если оно не определено или если `Document` был создан с помощью `DOMImplementation.createDocument`.
`void`	`setStrictErrorChecking(boolean strictErrorChecking)`	Атрибут, указывающий, включена ли проверка ошибок.
`void`	`setXmlStandalone(boolean xmlStandalone)`	Атрибут, указывающий в составе объявления XML, является ли этот документ автономным.
`void`	`setXmlVersion(String xmlVersion)`	Атрибут, задающий в составе объявления XML номер версии этого документа.

Методы, объявленные в интерфейсе 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)`	Связывает объект с ключом этого узла.

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

getDoctype

DocumentType getDoctype()

Объявление типа документа (см. DocumentType), связанное с этим документом. Для XML-документов без объявления типа документа возвращается null. Для HTML-документов может быть возвращён объект DocumentType независимо от наличия или отсутствия объявления типа документа в HTML-документе.
Это обеспечивает прямой доступ к узлу DocumentType, дочернему узлу этого Document. Этот узел можно задать при создании документа, а затем изменить с помощью методов управления дочерними узлами, таких как Node.insertBefore или Node.replaceChild. Однако обратите внимание, что хотя некоторые реализации могут создавать объекты Document различных типов, поддерживающие дополнительные возможности помимо «Core», например «HTML» [DOM Level 2 HTML], на основе DocumentType, указанного при создании, последующее изменение этого значения вряд ли приведёт к изменению поддерживаемых возможностей.

Начиная с:: 1.4, DOM Level 3

getImplementation

DOMImplementation getImplementation()

Объект DOMImplementation, который обрабатывает этот документ. DOM-приложение может использовать объекты нескольких реализаций.

getDocumentElement

Element getDocumentElement()

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

createElement

Element createElement(String tagName) throws DOMException

Создаёт элемент указанного типа. Обратите внимание, что возвращённый экземпляр реализует интерфейс Element, поэтому атрибуты можно задавать непосредственно для возвращённого объекта.
Кроме того, если известны атрибуты со значениями по умолчанию, автоматически создаются и присоединяются к элементу узлы Attr, представляющие эти атрибуты.
Чтобы создать элемент с квалифицированным именем и URI пространства имён, используйте метод createElementNS.

Параметры:: tagName - Имя типа создаваемого элемента. Для XML регистр символов имеет значение; в остальных случаях это зависит от чувствительности используемого языка разметки к регистру. В таком случае реализация DOM преобразует имя в каноническую форму этой разметки.
Возвращает:: Новый объект Element с атрибутом nodeName, установленным в tagName, и атрибутами localName, prefix и namespaceURI, установленными в null.
Вызывает исключение:: DOMException - INVALID_CHARACTER_ERR: возникает, если указанное имя не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.

createDocumentFragment

DocumentFragment createDocumentFragment()

Создаёт пустой объект DocumentFragment.

Возвращает:: Новый объект DocumentFragment.

createTextNode

Text createTextNode(String data)

Создаёт узел Text с указанной строкой.

Параметры:: data - Данные узла.
Возвращает:: Новый объект Text.

createComment

Comment createComment(String data)

Создаёт узел Comment с указанной строкой.

Параметры:: data - Данные узла.
Возвращает:: Новый объект Comment.

createCDATASection

CDATASection createCDATASection(String data) throws DOMException

Создаёт узел CDATASection, значением которого является указанная строка.

Параметры:: data - Данные для содержимого CDATASection.
Возвращает:: Новый объект CDATASection.
Вызывает исключение:: DOMException - NOT_SUPPORTED_ERR: возникает, если этот документ является HTML-документом.

createProcessingInstruction

ProcessingInstruction createProcessingInstruction(String target, String data) throws DOMException

Создаёт узел ProcessingInstruction с указанными строками имени и данных.

Параметры:: target - Целевая часть инструкции обработки. В отличие от Document.createElementNS или Document.createAttributeNS, проверка имени цели на корректность с точки зрения пространств имён не выполняется. Приложениям следует вызвать Document.normalizeDocument() с параметром «namespaces», установленным в true, чтобы убедиться, что имя цели корректно с точки зрения пространств имён.; data - Данные узла.
Возвращает:: Новый объект ProcessingInstruction.
Вызывает исключение:: DOMException - INVALID_CHARACTER_ERR: возникает, если указанная цель не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.
NOT_SUPPORTED_ERR: возникает, если этот документ является HTML-документом.

createAttribute

Attr createAttribute(String name) throws DOMException

Создаёт Attr с указанным именем. Обратите внимание, что экземпляр Attr можно затем установить для Element с помощью метода setAttributeNode.
Чтобы создать атрибут с квалифицированным именем и URI пространства имён, используйте метод createAttributeNS.

Параметры:: name - Имя атрибута.
Возвращает:: Новый объект Attr с атрибутом nodeName, установленным в name, и атрибутами localName, prefix и namespaceURI, установленными в null. Значением атрибута является пустая строка.
Вызывает исключение:: DOMException - INVALID_CHARACTER_ERR: возникает, если указанное имя не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.

createEntityReference

EntityReference createEntityReference(String name) throws DOMException

Создаёт объект EntityReference. Кроме того, если ссылка ведёт на известную сущность, список дочерних узлов узла EntityReference становится таким же, как у соответствующего узла Entity.

Примечание: Если у какого-либо потомка узла Entity имеется несвязанный префикс пространства имён, соответствующий потомок созданного узла EntityReference также будет несвязанным; его namespaceURI будет равен null. DOM Level 2 и 3 не предоставляют механизмов для разрешения префиксов пространств имён в этом случае.

Параметры:: name - Имя сущности, на которую нужно сослаться. В отличие от Document.createElementNS или Document.createAttributeNS, проверка имени сущности на корректность с точки зрения пространств имён не выполняется. Приложениям следует вызвать Document.normalizeDocument() с параметром «namespaces», установленным в true, чтобы убедиться, что имя сущности корректно с точки зрения пространств имён.
Возвращает:: Новый объект EntityReference.
Вызывает исключение:: DOMException - INVALID_CHARACTER_ERR: возникает, если указанное имя не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.
NOT_SUPPORTED_ERR: возникает, если этот документ является HTML-документом.

getElementsByTagName

NodeList getElementsByTagName(String tagname)

Возвращает NodeList всех Elements, содержащихся в документе и имеющих заданное имя тега, в порядке следования в документе.

Параметры:: tagname - Имя тега для поиска. Специальное значение «*» соответствует всем тегам. В случае XML параметр tagname чувствителен к регистру; в остальных случаях это зависит от чувствительности используемого языка разметки к регистру.
Возвращает:: Новый объект NodeList, содержащий все найденные Elements.

importNode

Node importNode(Node importedNode, boolean deep) throws DOMException

Импортирует узел из другого документа в этот документ, не изменяя и не удаляя исходный узел из исходного документа; этот метод создаёт новую копию исходного узла. У возвращённого узла нет родителя (parentNode равно null).
Для всех узлов импорт создаёт объект узла, принадлежащий импортирующему документу, со значениями атрибутов, идентичными значениям nodeName и nodeType исходного узла, а также атрибутами, связанными с пространствами имён (prefix, localName и namespaceURI). Как и при операции cloneNode, исходный узел не изменяется. Пользовательские данные, связанные с импортированным узлом, не переносятся. Однако если для любого UserDataHandlers был указан обработчик вместе со связанными данными, до возврата этим методом обработчики будут вызваны с соответствующими параметрами.
Дополнительная информация копируется в nodeType, насколько это уместно, с попыткой воспроизвести ожидаемое поведение при копировании фрагмента исходного кода XML или HTML из одного документа в другой, учитывая, что в случае XML документы могут иметь разные DTD. Ниже описаны особенности для каждого типа узла.

ATTRIBUTE_NODE: Для созданного Attr атрибут ownerElement устанавливается в null, а флаг specified — в true. Потомки исходного Attr рекурсивно импортируются, а полученные узлы собираются заново, образуя соответствующее поддерево. Обратите внимание, что параметр deep не влияет на узлы Attr; при импорте они всегда переносят с собой дочерние узлы.
DOCUMENT_FRAGMENT_NODE: Если параметр deep установлен в true, потомки исходного DocumentFragment рекурсивно импортируются, а полученные узлы собираются под импортированным DocumentFragment, образуя соответствующее поддерево. В противном случае создаётся только пустой DocumentFragment.
DOCUMENT_NODE: Узлы Document нельзя импортировать.
DOCUMENT_TYPE_NODE: Узлы DocumentType нельзя импортировать.
ELEMENT_NODE: Узлы атрибутов исходного элемента, для которых задано значение, импортируются, а созданные узлы Attr присоединяются к созданному Element. Атрибуты по умолчанию не копируются, однако если документ, в который выполняется импорт, определяет атрибуты по умолчанию для этого имени элемента, они назначаются. Если параметр deep importNode установлен в true, потомки исходного элемента рекурсивно импортируются, а полученные узлы собираются заново, образуя соответствующее поддерево.
ENTITY_NODE: Узлы Entity можно импортировать, однако в текущей версии DOM DocumentType доступен только для чтения. Возможность добавления этих импортированных узлов в DocumentType будет рассмотрена для включения в будущую версию DOM. При импорте копируются атрибуты publicId, systemId и notationName. Если запрошен импорт deep, потомки исходного Entity рекурсивно импортируются, а полученные узлы собираются заново, образуя соответствующее поддерево.
ENTITY_REFERENCE_NODE: Копируется только сам EntityReference, даже если запрошен импорт deep, поскольку сущность в исходном и целевом документах может быть определена по-разному. Если документ, в который выполняется импорт, содержит определение сущности с этим именем, ей присваивается соответствующее значение.
NOTATION_NODE: Узлы Notation можно импортировать, однако в текущей версии DOM DocumentType доступен только для чтения. Возможность добавления этих импортированных узлов в DocumentType будет рассмотрена для включения в будущую версию DOM. При импорте копируются атрибуты publicId и systemId. Обратите внимание, что параметр deep не влияет на этот тип узлов, поскольку у них не может быть дочерних узлов.
PROCESSING_INSTRUCTION_NODE: Значения target и data импортированного узла копируются из соответствующих значений исходного узла. Обратите внимание, что параметр deep не влияет на этот тип узлов, поскольку у них не может быть дочерних узлов.
TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE: Эти три типа узлов, наследующие от CharacterData, копируют атрибуты data и length исходного узла. Обратите внимание, что параметр deep не влияет на эти типы узлов, поскольку у них не может быть дочерних узлов.

Параметры:: importedNode - Узел для импорта.; deep - Если значение true, рекурсивно импортировать поддерево указанного узла; если значение false, импортировать только сам узел, как описано выше. Это не влияет на узлы, у которых не может быть дочерних узлов, а также на узлы Attr и EntityReference.
Возвращает:: Импортированный узел, принадлежащий этому Document.
Вызывает исключение:: DOMException - NOT_SUPPORTED_ERR: возникает, если тип импортируемого узла не поддерживается.
INVALID_CHARACTER_ERR: возникает, если одно из импортируемых имён не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion. Например, это может произойти при импорте элемента XML 1.1 [XML 1.1] в документ XML 1.0.
Начиная с:: 1.4, DOM Level 2

createElementNS

Element createElementNS(String namespaceURI, String qualifiedName) throws DOMException

Создаёт элемент с указанными квалифицированным именем и URI пространства имён.
Согласно [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если элемент не должен принадлежать пространству имён.

Параметры:

namespaceURI - URI пространства имён создаваемого элемента.

qualifiedName - Квалифицированное имя создаваемого типа элемента.

Возвращает:

Новый объект Element со следующими атрибутами:

Атрибуты объекта `Element`
Атрибут	Значение
`Node.nodeName`	`qualifiedName`
`Node.namespaceURI`	`namespaceURI`
`Node.prefix`	префикс, извлечённый из `qualifiedName`, или `null`, если префикса нет
`Node.localName`	локальное имя, извлечённое из `qualifiedName`
`Element.tagName`	`qualifiedName`

Вызывает исключение:

DOMException - INVALID_CHARACTER_ERR: возникает, если указанное qualifiedName не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.
NAMESPACE_ERR: возникает, если qualifiedName является некорректным квалифицированным именем; если у qualifiedName есть префикс, а namespaceURI равно null; если у qualifiedName есть префикс «xml», а namespaceURI отличается от « http://www.w3.org/XML/1998/namespace» [XML Namespaces]; если qualifiedName или его префикс равен «xmlns», а namespaceURI отличается от «http://www.w3.org/2000/xmlns/»; либо если namespaceURI равно «http://www.w3.org/2000/xmlns/», а ни qualifiedName, ни его префикс не равен «xmlns».
NOT_SUPPORTED_ERR: всегда возникает, если текущий документ не поддерживает возможность "XML", поскольку пространства имён были определены в XML.

Начиная с:

1.4, DOM Level 2

createAttributeNS

Attr createAttributeNS(String namespaceURI, String qualifiedName) throws DOMException

Создаёт атрибут с указанными квалифицированным именем и URI пространства имён.
Согласно [XML Namespaces], приложения должны использовать значение null в качестве параметра namespaceURI для методов, если атрибут не должен принадлежать пространству имён.

Параметры:

namespaceURI - URI пространства имён создаваемого атрибута.

qualifiedName - Квалифицированное имя создаваемого атрибута.

Возвращает:

Новый объект Attr со следующими атрибутами:

Атрибуты объекта `Attr`
Атрибут	Значение
`Node.nodeName`	qualifiedName
`Node.namespaceURI`	`namespaceURI`
`Node.prefix`	префикс, извлечённый из `qualifiedName`, или `null`, если префикса нет
`Node.localName`	локальное имя, извлечённое из `qualifiedName`
`Attr.name`	`qualifiedName`
`Node.nodeValue`	пустая строка

Вызывает исключение:

DOMException - INVALID_CHARACTER_ERR: возникает, если указанное qualifiedName не является именем XML согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.
NAMESPACE_ERR: возникает, если qualifiedName является некорректным квалифицированным именем; если у qualifiedName есть префикс, а namespaceURI равно null; если у qualifiedName есть префикс «xml», а namespaceURI отличается от « http://www.w3.org/XML/1998/namespace»; если qualifiedName или его префикс равен «xmlns», а namespaceURI отличается от «http://www.w3.org/2000/xmlns/»; либо если namespaceURI равно «http://www.w3.org/2000/xmlns/», а ни qualifiedName, ни его префикс не равен «xmlns».
NOT_SUPPORTED_ERR: всегда возникает, если текущий документ не поддерживает возможность "XML", поскольку пространства имён были определены в XML.

Начиная с:

1.4, DOM Level 2

getElementsByTagNameNS

NodeList getElementsByTagNameNS(String namespaceURI, String localName)

Возвращает NodeList всех Elements с заданными локальным именем и URI пространства имён в порядке следования в документе.

Параметры:: namespaceURI - URI пространства имён элементов для поиска. Специальное значение "*" соответствует всем пространствам имён.; localName - Локальное имя элементов для поиска. Специальное значение «*» соответствует всем локальным именам.
Возвращает:: Новый объект NodeList, содержащий все найденные Elements.
Начиная с:: 1.4, DOM Level 2

getElementById

Element getElementById(String elementId)

Возвращает Element, у которого атрибут ID имеет указанное значение. Если такого элемента нет, возвращается null. Если атрибут ID с таким значением есть у нескольких элементов, результат не определён.
Предполагается, что реализация DOM использует атрибут Attr.isId для определения того, является ли атрибут атрибутом типа ID.

Примечание: Атрибуты с именем «ID» или «id» не относятся к типу ID, если это не определено явно.

Параметры:: elementId - Уникальное значение id элемента.
Возвращает:: Соответствующий элемент или null, если такого элемента нет.
Начиная с:: 1.4, DOM Level 2

getInputEncoding

String getInputEncoding()

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

Начиная с:: 1.5, DOM Level 3

getXmlEncoding

String getXmlEncoding()

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

Начиная с:: 1.5, DOM Level 3

getXmlStandalone

boolean getXmlStandalone()

Атрибут, указывающий в составе объявления XML, является ли этот документ автономным. Если значение не указано, оно равно false.

Примечание: При установке значения атрибута проверка не выполняется. Приложениям следует использовать Document.normalizeDocument() с параметром «validate», чтобы проверить соответствие значения ограничению корректности объявления автономного документа, определённому в [XML 1.0].

Начиная с:: 1.5, DOM Level 3

setXmlStandalone

void setXmlStandalone(boolean xmlStandalone) throws DOMException

Вызывает исключение:: DOMException - NOT_SUPPORTED_ERR: возникает, если этот документ не поддерживает возможность «XML».
Начиная с:: 1.5, DOM Level 3

getXmlVersion

String getXmlVersion()

Атрибут, указывающий номер версии этого документа в составе объявления XML. Если объявление отсутствует и документ поддерживает возможность «XML», значением является "1.0". Если документ не поддерживает возможность «XML», значение всегда равно null. Изменение этого атрибута влияет на методы проверки недопустимых символов в именах XML. Приложению следует вызвать Document.normalizeDocument(), чтобы проверить наличие недопустимых символов в Node, уже входящих в состав этого Document.
DOM-приложения могут использовать метод DOMImplementation.hasFeature(feature, version) со значениями параметров «XMLVersion» и «1.0» (соответственно), чтобы определить, поддерживает ли реализация [XML 1.0]. DOM-приложения могут использовать тот же метод со значениями параметров «XMLVersion» и «1.1» (соответственно), чтобы определить, поддерживает ли реализация [XML 1.1]. В обоих случаях для поддержки XML реализация также должна поддерживать возможность «XML», определённую в этой спецификации. Объекты Document, поддерживающие версию возможности «XMLVersion», не должны вызывать исключение NOT_SUPPORTED_ERR для того же номера версии при использовании Document.xmlVersion.

Начиная с:: 1.5, DOM Level 3

setXmlVersion

void setXmlVersion(String xmlVersion) throws DOMException

Вызывает исключение:: DOMException - NOT_SUPPORTED_ERR: возникает, если для версии задано неподдерживаемое этим Document значение или если документ не поддерживает возможность «XML».
Начиная с:: 1.5, DOM Level 3

getStrictErrorChecking

boolean getStrictErrorChecking()

Атрибут, указывающий, выполняется ли строгая проверка ошибок. Если установлено значение false, реализация может не проверять все возможные случаи ошибок, обычно определённые для операций DOM, не вызывать исключения DOMException при выполнении операций DOM и не сообщать об ошибках при использовании Document.normalizeDocument(). Поведение в случае ошибки не определено. По умолчанию атрибут имеет значение true.

Начиная с:: 1.5, DOM Level 3

setStrictErrorChecking

void setStrictErrorChecking(boolean strictErrorChecking)

Начиная с:: 1.5, DOM Level 3

getDocumentURI

String getDocumentURI()

Местоположение документа или null, если оно не определено или если Document был создан с помощью DOMImplementation.createDocument. При установке этого атрибута лексическая проверка не выполняется; при использовании Node.baseURI может быть возвращено значение null.
Обратите внимание: если Document поддерживает функцию "HTML" [DOM Level 2 HTML], атрибут href элемента HTML BASE имеет приоритет над этим атрибутом при вычислении Node.baseURI.

Начиная с:: 1.5, DOM Level 3

setDocumentURI

void setDocumentURI(String documentURI)

Начиная с:: 1.5, DOM Level 3

adoptNode

Node adoptNode(Node source) throws DOMException

Пытается принять узел из другого документа в этот документ. Если эта операция поддерживается, она изменяет ownerDocument исходного узла, его дочерних узлов, а также присоединённых узлов атрибутов, если они есть. Если у исходного узла есть родитель, он сначала удаляется из списка дочерних узлов родителя. Это позволяет перемещать поддерево из одного документа в другой (в отличие от importNode(), которые создают копию исходного узла, а не перемещают его). В случае неудачи приложениям следует использовать вместо этого Document.importNode(). Обратите внимание: если принятый узел уже является частью этого документа (то есть исходный и целевой документы совпадают), этот метод всё равно удаляет исходный узел из списка дочерних узлов его родителя, если таковой имеется. В следующем списке описаны особенности для каждого типа узла.

ATTRIBUTE_NODE: Атрибут ownerElement устанавливается в null, а флаг specified устанавливается в true для принятого Attr. Потомки исходного Attr принимаются рекурсивно.
DOCUMENT_FRAGMENT_NODE: Потомки исходного узла принимаются рекурсивно.
DOCUMENT_NODE: Узлы Document нельзя принимать.
DOCUMENT_TYPE_NODE: Узлы DocumentType нельзя принимать.
ELEMENT_NODE: Узлы атрибутов исходного элемента, для которых задано значение Specified, принимаются. Атрибуты по умолчанию отбрасываются, однако, если в документе, в который принимается узел, для этого имени элемента определены атрибуты по умолчанию, они назначаются. Потомки исходного элемента принимаются рекурсивно.
ENTITY_NODE: Узлы Entity нельзя принимать.
ENTITY_REFERENCE_NODE: Принимается только сам узел EntityReference, а его потомки отбрасываются, поскольку в исходном и целевом документах сущность может быть определена по-разному. Если в документе, в который выполняется импорт, есть определение этой сущности, ему присваивается её значение.
NOTATION_NODE: Узлы Notation нельзя принимать.
PROCESSING_INSTRUCTION_NODE, TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE: Все эти узлы можно принимать. Особых условий нет.

Примечание: Поскольку этот метод, в отличие от метода Document.importNode(), не создаёт новые узлы, он не вызывает исключение INVALID_CHARACTER_ERR. Для проверки того, что импортируемое имя является допустимым XML-именем согласно используемой версии XML, приложениям следует использовать метод Document.normalizeDocument().

Параметры:: source - Узел, который нужно переместить в этот документ.
Возвращает:: Принятый узел или null, если операция завершается неудачей, например, когда исходный узел принадлежит другой реализации.
Вызывает исключения:: DOMException - NOT_SUPPORTED_ERR: возникает, если исходный узел имеет тип DOCUMENT, DOCUMENT_TYPE.
NO_MODIFICATION_ALLOWED_ERR: возникает, если исходный узел доступен только для чтения.
Начиная с:: 1.5, DOM Level 3

getDomConfig

DOMConfiguration getDomConfig()

Конфигурация, используемая при вызове Document.normalizeDocument().

Начиная с:: 1.5, DOM Level 3

normalizeDocument

void normalizeDocument()

Этот метод действует так, как если бы документ прошёл цикл сохранения и загрузки, приводя его к «нормальной» форме. В результате этот метод обновляет дерево замены узлов EntityReference и нормализует узлы Text, как определено в методе Node.normalize().
В остальных случаях фактический результат зависит от функций, заданных для объекта Document.domConfig, и определяющих, какие операции будут выполнены. В частности, этот метод может также привести пространство имён документа в соответствие с описанным алгоритмом, проверить нормализацию символов, удалить узлы CDATASection и т. д. Подробности см. в DOMConfiguration.

// Keep in the document
the information defined // in the XML Information Set (Java example)
DOMConfiguration docConfig = myDocument.getDomConfig();
docConfig.setParameter("infoset", Boolean.TRUE);
myDocument.normalizeDocument();

Если поддерживаются события мутации, они генерируются для отражения изменений, произошедших в документе.
Если при вызове этого метода возникают ошибки, например при попытке обновить узел, доступный только для чтения, или если Node.nodeName содержит недопустимый символ согласно используемой версии XML, об ошибках или предупреждениях (DOMError.SEVERITY_ERROR или DOMError.SEVERITY_WARNING) будет сообщено с помощью объекта DOMErrorHandler, связанного с параметром "error-handler ". Обратите внимание, что этот метод также может сообщать о фатальных ошибках ( DOMError.SEVERITY_FATAL_ERROR), если реализация не может восстановиться после ошибки.

Начиная с:: 1.5, DOM Level 3

renameNode

Node renameNode(Node n, String namespaceURI, String qualifiedName) throws DOMException

Переименовывает существующий узел типа ELEMENT_NODE или ATTRIBUTE_NODE.
Если возможно, имя указанного узла просто изменяется; в противном случае создаётся новый узел с заданным именем, который заменяет существующий узел, как описано ниже.
Если изменить имя указанного узла невозможно, выполняются следующие операции: создаётся новый узел, на него регистрируются все зарегистрированные обработчики событий, из старого узла удаляются все присоединённые к нему пользовательские данные, старый узел удаляется из родительского узла, если он есть, дочерние узлы перемещаются в новый узел, если переименовываемый узел является Element, его атрибуты перемещаются в новый узел, новый узел вставляется на место старого в списке дочерних узлов его родителя, если такой родитель есть, пользовательские данные, присоединённые к старому узлу, присоединяются к новому узлу.
Если переименовываемый узел является Element, перемещаются только атрибуты, для которых задано значение; атрибуты по умолчанию, определённые в DTD, обновляются в соответствии с новым именем элемента. Кроме того, реализация может обновить атрибуты по умолчанию из других схем. Приложениям следует использовать Document.normalizeDocument(), чтобы гарантировать актуальность этих атрибутов.
Если переименовываемый узел является Attr, присоединённым к Element, узел сначала удаляется из карты атрибутов Element. Затем после переименования, будь то изменение существующего узла или создание нового, как описано выше, он добавляется обратно.
Кроме того,

генерируется событие пользовательских данных NODE_RENAMED,
если реализация поддерживает функцию "MutationNameEvents", каждая операция мутации, выполняемая этим методом, генерирует соответствующее событие; в конце генерируется событие { http://www.w3.org/2001/xml-events, DOMElementNameChanged} или { http://www.w3.org/2001/xml-events, DOMAttributeNameChanged}.

Параметры:: n - Узел, который нужно переименовать.; namespaceURI - Новый URI пространства имён.; qualifiedName - Новое квалифицированное имя.
Возвращает:: Переименованный узел. Это либо указанный узел, либо новый узел, созданный для замены указанного узла.
Вызывает исключения:: DOMException - NOT_SUPPORTED_ERR: возникает, если тип указанного узла не ELEMENT_NODE и не ATTRIBUTE_NODE, либо если реализация не поддерживает переименование элемента документа.
INVALID_CHARACTER_ERR: возникает, если новое квалифицированное имя не является допустимым XML-именем согласно используемой версии XML, указанной в атрибуте Document.xmlVersion.
WRONG_DOCUMENT_ERR: возникает, если указанный узел был создан в другом документе.
NAMESPACE_ERR: возникает, если qualifiedName является некорректным квалифицированным именем, если у qualifiedName есть префикс, а namespaceURI равно null, либо если префикс qualifiedName равен "xml", а namespaceURI отличается от " http://www.w3.org/XML/1998/namespace" [Пространства имён XML]. Исключение также возникает, если переименовываемый узел является атрибутом, а qualifiedName или его префикс равен "xmlns", и namespaceURI отличается от "http://www.w3.org/2000/xmlns/".
Начиная с:: 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.