public interface NamedNodeMap
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 3 Core Specification.
| Modifier and Type | Method and Description |
|---|---|
int |
getLength()
The number of nodes in this map.
|
Node |
getNamedItem(String name)
Retrieves a node specified by name.
|
Node |
getNamedItemNS(String namespaceURI,
String localName)
Retrieves a node specified by local name and namespace URI.
|
Node |
item(int index)
Returns the
indexth item in the map. |
Node |
removeNamedItem(String name)
Removes a node specified by name.
|
Node |
removeNamedItemNS(String namespaceURI,
String localName)
Removes a node specified by local name and namespace URI.
|
Node |
setNamedItem(Node arg)
Adds a node using its
nodeName attribute. |
Node |
setNamedItemNS(Node arg)
Adds a node using its
namespaceURI and
localName. |
Node getNamedItem(String name)
name - The nodeName of a node to retrieve.Node (of any type) with the specified
nodeName, or null if it does not identify
any node in this map.Node setNamedItem(Node arg) throws DOMException
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.
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.arg - A node to store in this map. The node will later be
accessible using the value of its nodeName attribute.Node replaces an existing node the
replaced Node is returned, otherwise null
is returned.DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a
different document than the one that created this map.
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.
Node removeNamedItem(String name) throws DOMException
name - The nodeName of the node to remove.DOMException - NOT_FOUND_ERR: Raised if there is no node named name in
this map.
Node item(int index)
indexth item in the map. If index
is greater than or equal to the number of nodes in this map, this
returns null.index - Index into this map.indexth position in the map, or
null if that is not a valid index.int getLength()
0 to length-1 inclusive.Node getNamedItemNS(String namespaceURI, String localName) throws DOMException
namespaceURI - The namespace URI of the node to retrieve.localName - The local name of the node to retrieve.Node (of any type) with the specified local
name and namespace URI, or null if they do not
identify any node in this map.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]).Node setNamedItemNS(Node arg) throws DOMException
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.
arg - A node to store in this map. The node will later be
accessible using the value of its namespaceURI and
localName attributes.Node replaces an existing node the
replaced Node is returned, otherwise null
is returned.DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a
different document than the one that created this map.
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.
Node removeNamedItemNS(String namespaceURI, String localName) throws DOMException
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.
namespaceURI - The namespace URI of the node to remove.localName - The local name of the node to remove.DOMException - NOT_FOUND_ERR: Raised if there is no node with the specified
namespaceURI and localName in this map.
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved.