|
Enhydra 3.0.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
int |
getLength()
The number of nodes in the map. |
Node |
getNamedItem(java.lang.String name)
Retrieves a node specified by name. |
Node |
getNamedItemNS(java.lang.String namespaceURI,
java.lang.String localName)
Retrieves a node specified by local name and namespace URI. |
Node |
item(int index)
Returns the index th item in the map. |
Node |
removeNamedItem(java.lang.String name)
Removes a node specified by name. |
Node |
removeNamedItemNS(java.lang.String namespaceURI,
java.lang.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 . |
Method Detail |
public Node getNamedItem(java.lang.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 the map.public Node setNamedItem(Node arg) throws DOMException
nodeName
attribute.
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 a named node map. The node will later be
accessible using the value of the nodeName
attribute of
the node. If a node with that name is already present in the map, it
is replaced by the new one.Node
replaces an existing node the
replaced Node
is returned, otherwise null
is returned.arg
was created from a
different document than the one that created the
NamedNodeMap
.
NamedNodeMap
is readonly.
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.public Node removeNamedItem(java.lang.String name) throws DOMException
name
- The nodeName
of the node to remove. When this
NamedNodeMap
contains the attributes attached to an
element, as returned by the attributes attribute of the
Node
interface, 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.name
in
the map.
NamedNodeMap
is readonly.public Node item(int index)
index
th item in the map. If index
is greater than or equal to the number of nodes in the map, this
returns null
.index
- Index into the map.index
th position in the
NamedNodeMap
, or null
if that is not a
valid index.public int getLength()
length-1
inclusive.public Node getNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)
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 the map.public Node setNamedItemNS(Node arg) throws DOMException
namespaceURI
and
localName
. HTML-only DOM implementations do not need to
implement this method.arg
- A node to store in a named node map. The node will later be
accessible using the value of the namespaceURI
and
localName
attribute of the node. If a node with those
namespace URI and local name is already present in the map, it is
replaced by the new one.Node
replaces an existing node the
replaced Node
is returned, otherwise null
is returned.arg
was created from a
different document than the one that created the
NamedNodeMap
.
NamedNodeMap
is readonly.
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.public Node removeNamedItemNS(java.lang.String namespaceURI, java.lang.String localName) throws DOMException
namespaceURI
- The namespace URI of the node to remove.localName
- The local name of the node to remove. When this
NamedNodeMap
contains the attributes attached to an
element, as returned by the attributes attribute of the
Node
interface, 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.name
in
the map.
NamedNodeMap
is readonly.
|
Enhydra 3.0.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |