org.jboss.axis.message
Class NamedNodeMapImpl

java.lang.Object
  org.jboss.axis.message.NamedNodeMapImpl

All Implemented Interfaces:

NamedNodeMap

public class NamedNodeMapImpl
extends Object
implements NamedNodeMap

A W3C simple DOM NameNodeMap implementation

Author:

Heejune Ahn (cityboy@tmax.co.kr)

Field Summary

protected Vector

nodes Nodes.

Constructor Summary

NamedNodeMapImpl()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected Vector nodes

Nodes.

Constructor Detail

NamedNodeMapImpl

public NamedNodeMapImpl()

Method Detail

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.

setNamedItem

public Node setNamedItem(Node arg)
                  throws DOMException

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.

Throws:

DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a

different document than the one that created this map.

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.

HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node

doesn't belong in this NamedNodeMap. Examples would include trying

to insert something other than an Attr node into an Element's map

of attributes, or a non-Entity node into the DocumentType's map of

Entities.

removeNamedItem

public Node removeNamedItem(String name)
                     throws DOMException

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.

Throws:

DOMException - NOT_FOUND_ERR: Raised if there is no node named name in

this map.

NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

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.

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

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

setNamedItemNS

public Node setNamedItemNS(Node arg)
                    throws DOMException

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.

Throws:

DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a

different document than the one that created this map.

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.

HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node

doesn't belong in this NamedNodeMap. Examples would include trying

to insert something other than an Attr node into an Element's map

of attributes, or a non-Entity node into the DocumentType's map of

Entities.

NOT_SUPPORTED_ERR: Always thrown if the current document does not

support the "XML" feature, since namespaces were

defined by XML.

Since:

DOM Level 2

removeNamedItemNS

public Node removeNamedItemNS(String namespaceURI,
                              String localName)
                       throws DOMException

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.

Throws:

DOMException - NOT_FOUND_ERR: Raised if there is no node with the specified

namespaceURI and localName in this map.

NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

Since:

DOM Level 2