Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
org.w3c.dom

Interface NamedNodeMap

java.lang.Object
|
+--org.w3c.dom.NamedNodeMap


public interface NamedNodeMap

Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name. Note that NamedNodeMap does not inherit from NodeList; NamedNodeMaps are not maintained in any particular order. Objects contained in an object implementing NamedNodeMap may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of a NamedNodeMap, and does not imply that the DOM specifies an order to these Nodes.

NamedNodeMap objects in the DOM are live.

See also the Document Object Model (DOM) Level 2 Core Specification.

Method Summary

intgetLength()

The number of nodes in this map.
org.w3c.dom.NodegetNamedItem(java.lang.String name)

Retrieves a node specified by name.
org.w3c.dom.NodegetNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)

Retrieves a node specified by local name and namespace URI.
org.w3c.dom.Nodeitem(int index)

Returns the indexth item in the map.
org.w3c.dom.NoderemoveNamedItem(java.lang.String name)

Removes a node specified by name.
org.w3c.dom.NoderemoveNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)

Removes a node specified by local name and namespace URI.
org.w3c.dom.NodesetNamedItem(org.w3c.dom.Node arg)

Adds a node using its nodeName attribute.
org.w3c.dom.NodesetNamedItemNS(org.w3c.dom.Node arg)

Adds a node using its namespaceURI and localName.

Method Details

getLength

public int getLength()

The number of nodes in this map. The range of valid child node indices is 0 to length-1 inclusive.


getNamedItem

public Node getNamedItem(java.lang.String name)

Retrieves a node specified by name.

Parameters:

Returns:


getNamedItemNS

public Node getNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)

Retrieves a node specified by local name and namespace URI.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

Since:Parameters:

Returns:


item

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:

Returns:


removeNamedItem

public Node removeNamedItem(java.lang.String name)

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:

Returns:

Throws:


removeNamedItemNS

public Node removeNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)

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.
Documents which do not support the "XML" feature will permit only the DOM Level 1 calls for creating/setting elements and attributes. Hence, if you specify a non-null namespace URI, these DOMs will never find a matching node.

Since:Parameters:

Returns:

Throws:


setNamedItem

public Node setNamedItem(org.w3c.dom.Node arg)

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

Returns:

Throws:


setNamedItemNS

public Node setNamedItemNS(org.w3c.dom.Node arg)

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.

Since:Parameters:

Returns:

Throws: