Интерфейс NamedNodeMap
public interface NamedNodeMap
Объекты, реализующие интерфейс
NamedNodeMap, используются для представления коллекций узлов, к которым можно получить доступ по имени. Обратите внимание, что NamedNodeMap не наследуется от NodeList; NamedNodeMaps не сохраняются в определённом порядке. К объектам, содержащимся в объекте, реализующем NamedNodeMap, также можно получить доступ по порядковому индексу, но это просто для удобного перечисления содержимого NamedNodeMap, и это не подразумевает, что DOM определяет порядок этих узлов. NamedNodeMap объекты в DOM являются динамическими.
См. также Спецификацию Document Object Model (DOM) Level 3 Core.
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
int |
getLength() |
Количество узлов в этом отображении. |
Node |
getNamedItem |
Возвращает узел, заданный именем. |
Node |
getNamedItemNS |
Возвращает узел, заданный локальным именем и URI пространства имён. |
Node |
item |
Возвращает index-й элемент в отображении. |
Node |
removeNamedItem |
Удаляет узел, заданный именем. |
Node |
removeNamedItemNS |
Удаляет узел, заданный локальным именем и URI пространства имён. |
Node |
setNamedItem |
Добавляет узел, используя его атрибут nodeName. |
Node |
setNamedItemNS |
Добавляет узел, используя его атрибуты namespaceURI и localName. |
Подробное описание методов
getNamedItem
Node getNamedItem(String name)
Возвращает узел, заданный именем.
- Параметры:
-
name- Имя узла для извлечения. - Возвращает:
- Узел (любого типа) с заданным именем, или
null, если по нему не удалось найти узел в отображении.
setNamedItem
Node setNamedItem(Node arg) throws DOMException
Добавляет узел, используя его атрибут
Так как атрибут
nodeName. Если узел с таким именем уже присутствует в этом отображении, он заменяется новым. Замена узла самим собой не оказывает никакого эффекта. Так как атрибут
nodeName используется для получения имени, под которым должен храниться узел, несколько узлов определённых типов (имеющих «специальное» строковое значение) не могут быть сохранены, поскольку имена будут конфликтовать. Это предпочтительнее, чем разрешать узлам иметь псевдонимы.- Параметры:
-
arg- Узел для хранения в этом отображении. Позже к узлу можно будет получить доступ, используя значение его атрибутаnodeName. - Возвращает:
- Если новый узел заменяет существующий, возвращается заменённый
Node, в противном случае возвращаетсяnull. - Исключения:
-
DOMException- WRONG_DOCUMENT_ERR: Возникает, еслиargбыл создан из другого документа, чем документ, создавший это отображение.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если это отображение только для чтения.
INUSE_ATTRIBUTE_ERR: Возникает, еслиargявляетсяAttr, который уже является атрибутом другого объектаElement. Пользователь DOM должен явно клонироватьAttrузлы, чтобы повторно использовать их в других элементах.
HIERARCHY_REQUEST_ERR: Возникает, если попытка добавления узла не соответствует структуре. Примеры включают попытку вставить что-либо, кроме узла Attr, в отображение атрибутов элемента, или узел, не являющийся Entity, в отображение сущностей DocumentType.
removeNamedItem
Node removeNamedItem(String name) throws DOMException
Удаляет узел, заданный именем. Когда это отображение содержит атрибуты, прикреплённые к элементу, если удалённый атрибут известен как имеющий значение по умолчанию, сразу же появляется атрибут, содержащий значение по умолчанию, а также соответствующий URI пространства имён, локальное имя и префикс, если применимо.
- Параметры:
-
name- Имя узла для удаления. - Возвращает:
- Узел, удалённый из этого отображения, если узел с таким именем существует.
- Исключения:
-
DOMException- NOT_FOUND_ERR: Возникает, если в этом отображении нет узла с именемname.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если это отображение только для чтения.
item
Node item(int index)
Возвращает
index-й элемент в отображении. Если index больше или равно количеству узлов в этом отображении, возвращается null.- Параметры:
-
index- Индекс в этом отображении. - Возвращает:
- Узел на
index-й позиции в отображении, илиnullесли этот индекс недопустим.
getLength
int getLength()
Количество узлов в этом отображении. Диапазон допустимых индексов узлов-потомков
0 до length-1 включительно.getNamedItemNS
Node getNamedItemNS(String namespaceURI, String localName) throws DOMException
Возвращает узел, заданный локальным именем и URI пространства имён.
Согласно [XML Namespaces] , приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
Согласно [XML Namespaces] , приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
- Параметры:
-
namespaceURI- URI пространства имён узла для извлечения. -
localName- Локальное имя узла для извлечения. - Возвращает:
- Узел (любого типа) с заданным локальным именем и URI пространства имён, или
nullесли по нему не удалось найти узел в отображении. - Исключения:
-
DOMException- NOT_SUPPORTED_ERR: Может быть вызван, если реализация не поддерживает «XML» и язык, экспонируемый через Document, не поддерживает XML пространства имён (например, [HTML 4.01]). - С момента:
- 1.4, DOM Level 2
setNamedItemNS
Node setNamedItemNS(Node arg) throws DOMException
Добавляет узел, используя его URI пространства имён и локальное имя. Если узел с этим URI пространства имён и локальным именем уже присутствует в этом отображении, он заменяется новым. Замена узла самим собой не оказывает никакого эффекта.
Согласно [XML Namespaces] , приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
Согласно [XML Namespaces] , приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
- Параметры:
-
arg- Узел для хранения в этом отображении. Позже к узлу можно будет получить доступ, используя значения его атрибутовnamespaceURIиlocalName. - Возвращает:
- Если новый узел заменяет существующий, возвращается заменённый
Node, в противном случае возвращаетсяnull. - Исключения:
-
DOMException- WRONG_DOCUMENT_ERR: Возникает, еслиargбыл создан из другого документа, чем документ, создавший это отображение.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если это отображение только для чтения.
INUSE_ATTRIBUTE_ERR: Возникает, еслиargявляетсяAttr, который уже является атрибутом другого объектаElement. Пользователь DOM должен явно клонироватьAttrузлы, чтобы повторно использовать их в других элементах.
HIERARCHY_REQUEST_ERR: Возникает, если попытка добавления узла не соответствует структуре. Примеры включают попытку вставить что-либо, кроме узла Attr, в отображение атрибутов элемента, или узел, не являющийся Entity, в отображение сущностей DocumentType.
NOT_SUPPORTED_ERR: Может быть вызван, если реализация не поддерживает «XML» и язык, экспонируемый через Document, не поддерживает XML пространства имён (например, [HTML 4.01]). - С момента:
- 1.4, DOM Level 2
removeNamedItemNS
Node removeNamedItemNS(String namespaceURI, String localName) throws DOMException
Удаляет узел, заданный локальным именем и URI пространства имён. Удалённый атрибут может быть известен как имеющий значение по умолчанию, когда это отображение содержит атрибуты, прикреплённые к элементу, как возвращается атрибутом attributes интерфейса
Согласно [XML Namespaces] , приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
Node. Если это так, сразу же появляется атрибут, содержащий значение по умолчанию, а также соответствующий URI пространства имён, локальное имя и префикс, если применимо. Согласно [XML Namespaces] , приложения должны использовать значение null в качестве параметра namespaceURI для методов, если они не хотят использовать пространство имён.
- Параметры:
-
namespaceURI- URI пространства имён узла для удаления. -
localName- Локальное имя узла для удаления. - Возвращает:
- Узел, удалённый из этого отображения, если узел с таким локальным именем и URI пространства имён существует.
- Исключения:
-
DOMException- NOT_FOUND_ERR: Возникает, если в этом отображении нет узла со заданнымnamespaceURIиlocalName.
NO_MODIFICATION_ALLOWED_ERR: Возникает, если это отображение только для чтения.
NOT_SUPPORTED_ERR: Может быть вызван, если реализация не поддерживает «XML» и язык, экспонируемый через Document, не поддерживает XML пространства имён (например, [HTML 4.01]). - С момента:
- 1.4, DOM Level 2
© 1993, 2021, 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.
https://docs.oracle.com/en/java/javase/17/docs/api/java.xml/org/w3c/dom/NamedNodeMap.html