org.apache.xerces.dom3.as

Interface ASNamedObjectMap

public interface ASNamedObjectMap

Method Summary

int
getLength()
The number of ASObjects in the ASObjectList.
ASObject
getNamedItem(String name)
Retrieves an ASObject specified by name.
ASObject
getNamedItemNS(String namespaceURI, String localName)
Retrieves an ASObject specified by local name and namespace URI.
ASObject
item(int index)
Returns the indexth item in the map.
ASObject
removeNamedItem(String name)
Removes an ASObject specified by a nodeName.
ASObject
removeNamedItemNS(String namespaceURI, String localName)
Removes an ASObject specified by a namespace URI and a local name.
ASObject
setNamedItem(ASObject newASObject)
Adds an ASObject using its nodeName attribute.
ASObject
setNamedItemNS(ASObject newASObject)
Adds an ASObject using its namespaceURI and localName.

Method Details

getLength

public int getLength()
The number of ASObjects in the ASObjectList. The range of valid child node indices is 0 to length-1 inclusive.

getNamedItem

public ASObject getNamedItem(String name)
Retrieves an ASObject specified by name.
Parameters:
name - The nodeName of an ASObject to retrieve.
Returns:
An ASObject with specified node name and null if the map does not contain an element with the given name.

getNamedItemNS

public ASObject getNamedItemNS(String namespaceURI,
                               String localName)
Retrieves an ASObject specified by local name and namespace URI.
Parameters:
namespaceURI - The namespace URI of the ASObject to retrieve.
localName - The local name of the ASObject to retrieve.
Returns:
A ASObject (of any type) with the specified local name and namespace URI, or null if they do not identify any ASObject in this map.

item

public ASObject item(int index)
Returns the indexth item in the map. The index starts at 0. If index is greater than or equal to the number of nodes in the list, this returns null.
Parameters:
index - The position in the map from which the item is to be retrieved.
Returns:
The ASObject at the indexth position in the ASNamedObjectMap, or null if that is not a valid index.

removeNamedItem

public ASObject removeNamedItem(String name)
            throws DOMException
Removes an ASObject specified by a nodeName.
Parameters:
name - The nodeName of the ASObject to be removed.
Returns:
The ASObject removed from this map if an ASObject with such a name exists.

removeNamedItemNS

public ASObject removeNamedItemNS(String namespaceURI,
                                  String localName)
            throws DOMException
Removes an ASObject specified by a namespace URI and a local name.
Parameters:
namespaceURI - The namespace URI of the ASObject to be removed.
localName - The local name of the ASObject to remove.
Returns:
The ASObject removed from this map if an ASObject with such a local name and namespace URI exists.

setNamedItem

public ASObject setNamedItem(ASObject newASObject)
            throws DOMException
Adds an ASObject using its nodeName attribute. If an ASObject with that name is already present in this map, it is replaced by the new one.
Parameters:
newASObject - The ASObject to be inserted in the map with its nodeName as the key.
Returns:
If the new node replaces an existing one, the replaced node is returned, otherwise null.

setNamedItemNS

public ASObject setNamedItemNS(ASObject newASObject)
            throws DOMException
Adds an ASObject using its namespaceURI and localName. If an ASObject with the same namespaceURI and localName is already present in this map, it is replaced by the new one.
Parameters:
newASObject - The ASObject to be inserted in the map.The ASObject will later be accessible using the value of its namespaceURI and localName attributes.
Returns:
If the new node replaces an existing one, the replaced node is returned, otherwise null.

Copyright © 1999-2004 Apache XML Project. All Rights Reserved.