OpenJDK 1.23 · org.w3c.dom.NamedNodeMap · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public int	getLength() The number of nodes in this map.
public Node	Returns: A `Node` (of any type) with the specified `nodeName`, or `null` if it does not identify any node in this map. getNamedItem(String The `nodeName` of a node to retrieve. name) Retrieves a node specified by name.
public Node	Returns: A `Node` (of any type) with the specified local name and namespace URI, or `null` if they do not identify any node in this map. getNamedItemNS(String The namespace URI of the node to retrieve. namespaceURI, String The local name of the node to retrieve. localName) Retrieves a node specified by local name and namespace URI.
public Node	Returns: The node at the `index`th position in the map, or `null` if that is not a valid index. item(int Index into this map. index) Returns the `index`th item in the map.
public Node	Returns: The node removed from this map if a node with such a name exists. removeNamedItem(String The `nodeName` of the node to remove. name) Removes a node specified by name.
public Node	Returns: The node removed from this map if a node with such a local name and namespace URI exists. removeNamedItemNS(String The namespace URI of the node to remove. namespaceURI, String The local name of the node to remove. localName) Removes a node specified by local name and namespace URI.
public Node	Returns: If the new `Node` replaces an existing node the replaced `Node` is returned, otherwise `null` is returned. setNamedItem(Node A node to store in this map. The node will later be accessible using the value of its `nodeName` attribute. arg) Adds a node using its `nodeName` attribute.
public Node	Returns: If the new `Node` replaces an existing node the replaced `Node` is returned, otherwise `null` is returned. setNamedItemNS(Node A node to store in this map. The node will later be accessible using the value of its `namespaceURI` and `localName` attributes. arg) Adds a node using its `namespaceURI` and `localName`.

Method Detail

getLength	back to summary
public int getLength() The number of nodes in this map. The range of valid child node indices is `0` to `length-1` inclusive.

getNamedItem back to summary

getNamedItem	back to summary
public Node getNamedItem(String name) Retrieves a node specified by name. Parameters name:String The `nodeName` of a node to retrieve. Returns:Node A `Node` (of any type) with the specified `nodeName`, or `null` if it does not identify any node in this map.

public Node getNamedItem(String name)

Retrieves a node specified by name.

Parameters

name:String: The nodeName of a node to retrieve.

Returns:Node

A Node (of any type) with the specified nodeName, or null if it does not identify any node in this map.

getNamedItemNS back to summary

getNamedItemNS	back to summary
public Node getNamedItemNS(String namespaceURI, String localName) throws DOMException Retrieves a node specified by local name and namespace URI. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace. Parameters namespaceURI:String The namespace URI of the node to retrieve. localName:String The local name of the node to retrieve. Returns:Node A `Node` (of any type) with the specified local name and namespace URI, or `null` if they do not identify any node in this map. Exceptions DOMException: NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]). Since 1.4, DOM Level 2

public Node getNamedItemNS(String namespaceURI, String localName) throws DOMException

Retrieves a node specified by local name and namespace URI.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters

namespaceURI:String: The namespace URI of the node to retrieve.
localName:String: The local name of the node to retrieve.

Returns:Node

A Node (of any type) with the specified local name and namespace URI, or null if they do not identify any node in this map.

Exceptions

DOMException:: NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since

1.4, DOM Level 2

item back to summary

item	back to summary
public Node item(int index) Returns the `index`th item in the map. If `index` is greater than or equal to the number of nodes in this map, this returns `null`. Parameters index:int Index into this map. Returns:Node The node at the `index`th position in the map, or `null` if that is not a valid index.

public Node item(int index)

Returns the indexth item in the map. If index is greater than or equal to the number of nodes in this map, this returns null.

Parameters

index:int: Index into this map.

Returns:Node

The node at the indexth position in the map, or null if that is not a valid index.

removeNamedItem back to summary

removeNamedItem	back to summary
public Node removeNamedItem(String name) throws DOMException Removes a node specified by name. When this map contains the attributes attached to an element, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable. Parameters name:String The `nodeName` of the node to remove. Returns:Node The node removed from this map if a node with such a name exists. Exceptions DOMException: NOT_FOUND_ERR: Raised if there is no node named `name` in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

public Node removeNamedItem(String name) throws DOMException

Removes a node specified by name. When this map contains the attributes attached to an element, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

Parameters

name:String: The nodeName of the node to remove.

Returns:Node

The node removed from this map if a node with such a name exists.

Exceptions

DOMException:: NOT_FOUND_ERR: Raised if there is no node named name in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

removeNamedItemNS back to summary

removeNamedItemNS	back to summary
public Node removeNamedItemNS(String namespaceURI, String localName) throws DOMException Removes a node specified by local name and namespace URI. A removed attribute may be known to have a default value when this map contains the attributes attached to an element, as returned by the attributes attribute of the `Node` interface. If so, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace. Parameters namespaceURI:String The namespace URI of the node to remove. localName:String The local name of the node to remove. Returns:Node The node removed from this map if a node with such a local name and namespace URI exists. Exceptions DOMException: NOT_FOUND_ERR: Raised if there is no node with the specified `namespaceURI` and `localName` in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]). Since 1.4, DOM Level 2

public Node removeNamedItemNS(String namespaceURI, String localName) throws DOMException

Removes a node specified by local name and namespace URI. A removed attribute may be known to have a default value when this map contains the attributes attached to an element, as returned by the attributes attribute of the Node interface. If so, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters

namespaceURI:String: The namespace URI of the node to remove.
localName:String: The local name of the node to remove.

Returns:Node

The node removed from this map if a node with such a local name and namespace URI exists.

Exceptions

DOMException:: NOT_FOUND_ERR: Raised if there is no node with the specified namespaceURI and localName in this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since

1.4, DOM Level 2

setNamedItem back to summary

setNamedItem	back to summary
public Node setNamedItem(Node arg) throws DOMException Adds a node using its `nodeName` attribute. If a node with that name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect. As the `nodeName` attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased. Parameters arg:Node A node to store in this map. The node will later be accessible using the value of its `nodeName` attribute. Returns:Node If the new `Node` replaces an existing node the replaced `Node` is returned, otherwise `null` is returned. Exceptions DOMException: WRONG_DOCUMENT_ERR: Raised if `arg` was created from a different document than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if `arg` is an `Attr` that is already an attribute of another `Element` object. The DOM user must explicitly clone `Attr` nodes to re-use them in other elements. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.

public Node setNamedItem(Node arg) throws DOMException

Adds a node using its nodeName attribute. If a node with that name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect.
As the nodeName attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased.

Parameters

arg:Node: A node to store in this map. The node will later be accessible using the value of its nodeName attribute.

Returns:Node

If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.

Exceptions

DOMException:: WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.

setNamedItemNS back to summary

setNamedItemNS	back to summary
public Node setNamedItemNS(Node arg) throws DOMException Adds a node using its `namespaceURI` and `localName`. If a node with that namespace URI and that local name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect. Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace. Parameters arg:Node A node to store in this map. The node will later be accessible using the value of its `namespaceURI` and `localName` attributes. Returns:Node If the new `Node` replaces an existing node the replaced `Node` is returned, otherwise `null` is returned. Exceptions DOMException: WRONG_DOCUMENT_ERR: Raised if `arg` was created from a different document than the one that created this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. INUSE_ATTRIBUTE_ERR: Raised if `arg` is an `Attr` that is already an attribute of another `Element` object. The DOM user must explicitly clone `Attr` nodes to re-use them in other elements. HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities. NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]). Since 1.4, DOM Level 2

public Node setNamedItemNS(Node arg) throws DOMException

Adds a node using its namespaceURI and localName. If a node with that namespace URI and that local name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect.
Per [XML Namespaces] , applications must use the value null as the namespaceURI parameter for methods if they wish to have no namespace.

Parameters

arg:Node: A node to store in this map. The node will later be accessible using the value of its namespaceURI and localName attributes.

Returns:Node

If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.

Exceptions

DOMException:: WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since

1.4, DOM Level 2

public Interface NamedNodeMap

Method Summary

Method Detail