org.kde.koala
Class NamedNodeMap

java.lang.Object
  extended by org.kde.koala.NamedNodeMap
All Implemented Interfaces:
org.kde.qt.QtSupport

public class NamedNodeMap
extends java.lang.Object
implements org.kde.qt.QtSupport

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 ArrayList ; NamedNodeMap s 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.


Constructor Summary
  NamedNodeMap()
           
protected NamedNodeMap(java.lang.Class dummy)
           
  NamedNodeMap(NamedNodeMap other)
           
 
Method Summary
 Node getNamedItem(java.lang.String name)
          Retrieves a node specified by name.
 Node getNamedItemNS(java.lang.String namespaceURI, java.lang.String localName)
          Introduced in DOM Level 2 Retrieves a node specified by local name and namespace URI.
 boolean isNull()
          not part of the DOM
 Node item(long index)
          Returns the index th item in the map.
 long length()
          The number of nodes 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)
          Introduced in DOM Level 2 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)
          Introduced in DOM Level 2 Adds a node using its namespaceURI and localName.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NamedNodeMap

protected NamedNodeMap(java.lang.Class dummy)

NamedNodeMap

public NamedNodeMap()

NamedNodeMap

public NamedNodeMap(NamedNodeMap other)
Method Detail

length

public long length()
The number of nodes in the 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:
name - Name of a node to retrieve.
Returns:
A Node (of any type) with the specified name, or null if the specified name did not identify any node in the map.

setNamedItem

public Node setNamedItem(Node arg)
Adds a node using its nodeName attribute. 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 - 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. NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap 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.
Returns:
If the new Node replaces an existing node with the same name the previously existing Node is returned, otherwise null is returned.

removeNamedItem

public Node removeNamedItem(java.lang.String name)
Removes a node specified by name. If the removed node is an Attr with a default value it is immediately replaced.

Parameters:
name - The name of a node to remove.
Returns:
The node removed from the map or null if no node with such a name exists.

item

public Node item(long index)
Returns the index th item in the map. If index is greater than or equal to the number of nodes in the map, this returns null .

Parameters:
index - Index into the map.
Returns:
The node at the index th position in the NamedNodeMap , or null if that is not a valid index.

getNamedItemNS

public Node getNamedItemNS(java.lang.String namespaceURI,
                           java.lang.String localName)
Introduced in DOM Level 2 Retrieves a node specified by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Parameters:
namespaceURI - The namespace URI of the node to retrieve.
localName - The local name of the node to retrieve.
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.

setNamedItemNS

public Node setNamedItemNS(Node arg)
Introduced in DOM Level 2 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. HTML-only DOM implementations do not need to implement this method.

Parameters:
arg - A node to store in this map. The node will later be accessible using the value of its namespaceURI and localName attributes. 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.
Returns:
If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.

removeNamedItemNS

public Node removeNamedItemNS(java.lang.String namespaceURI,
                              java.lang.String localName)
Introduced in DOM Level 2 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. HTML-only DOM implementations do not need to implement this method.

Parameters:
namespaceURI - The namespace URI of the node to remove.
localName - The local name of the node to remove. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
Returns:
The node removed from this map if a node with such a local name and namespace URI exists.

isNull

public boolean isNull()
not part of the DOM