com.teamkonzept.dom4jb.dom
Class NamedNodeMap

java.lang.Object
  |
  +--com.teamkonzept.dom4jb.dom.NamedNodeMap

All Implemented Interfaces:

NamedNodeMap

public class NamedNodeMap

extends Object

implements NamedNodeMap

Field Summary

protected static int

initialCapacity

Constructor Summary

protected	NamedNodeMap() Creates new NamedNodeMap
	NamedNodeMap(Node parent, ContentIterator iterator) Creates new NamedNodeMap

Method Summary

NamedNode	get(NodeName key) Returns the value to which this map maps the specified key.
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.
protected NamedNode	put(NamedNode node) Associates the specified value with the specified key in this map.
protected NamedNode	remove(NodeName node) Removes the mapping for this key from this map if present.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

initialCapacity

protected static final int initialCapacity

See Also:

Constant Field Values

Constructor Detail

NamedNodeMap

protected NamedNodeMap()

Creates new NamedNodeMap

NamedNodeMap

public NamedNodeMap(Node parent,
                    ContentIterator iterator)

Creates new NamedNodeMap

Method Detail

put

protected NamedNode put(NamedNode node)

Associates the specified value with the specified key in this map. If the map previously contained a mapping for this key, the old value is replaced.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the HashMap previously associated null with the specified key.

remove

protected NamedNode remove(NodeName node)

Removes the mapping for this key from this map if present.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

get

public NamedNode get(NodeName key)

Returns the value to which this map maps the specified key. Returns null if the map contains no mapping for this key.

Parameters:

key - key whose associated value is to be returned.

Returns:

the value to which this map maps the specified key.

getLength

public int getLength()

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

Specified by:

getLength in interface NamedNodeMap

removeNamedItem

public Node removeNamedItem(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.

Specified by:

removeNamedItem in interface NamedNodeMap

Parameters:

name - The nodeName of the node to remove.

Returns:

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

setNamedItemNS

public Node setNamedItemNS(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.

Specified by:

setNamedItemNS in interface NamedNodeMap

Parameters:

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

Returns:

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

Since:

DOM Level 2

setNamedItem

public Node setNamedItem(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.

Specified by:

setNamedItem in interface NamedNodeMap

Parameters:

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

Returns:

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

getNamedItemNS

public Node getNamedItemNS(String namespaceURI,
                           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.

Specified by:

getNamedItemNS in interface NamedNodeMap

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.

Since:

DOM Level 2

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.

Specified by:

item in interface NamedNodeMap

Parameters:

index - Index into this map.

Returns:

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

getNamedItem

public Node getNamedItem(String name)

Retrieves a node specified by name.

Specified by:

getNamedItem in interface NamedNodeMap

Parameters:

name - The nodeName of a node to retrieve.

Returns:

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

removeNamedItemNS

public Node removeNamedItemNS(String namespaceURI,
                              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.

Specified by:

removeNamedItemNS in interface NamedNodeMap

Parameters:

namespaceURI - The namespace URI of the node to remove.

localName - The local name of the node to remove.

Returns:

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

Since:

DOM Level 2