/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2002 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.tax.dom;

import org.w3c.dom.*;
import org.netbeans.tax.*;

/**
 *
 * @author  Petr Kuzel
 */
class NamedNodeMapImpl implements NamedNodeMap {
    
    private final TreeNamedObjectMap peer;
    
    /** Creates a new instance of AttrImpl */
    public NamedNodeMapImpl(TreeNamedObjectMap peer) {
        this.peer = peer;        
    }
    
    /** The number of nodes in this map. The range of valid child node indices
     * is 0 to length-1 inclusive.
     *
     */
    public int getLength() {
        return peer.size();
    }
    
    /** Retrieves a node specified by name.
     * @param name The nodeName of a node to retrieve.
     * @return A Node (of any type) with the specified
     *   nodeName, or null if it does not identify
     *   any node in this map.
     *
     */
    public Node getNamedItem(String name) {
        return Wrapper.wrap((TreeObject)peer.get(name));
    }
    
    /** 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.
     * @param namespaceURI The namespace URI of the node to retrieve.
     * @param localName The local name of the node to retrieve.
     * @return 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
     *
     */
    public Node getNamedItemNS(String namespaceURI, String localName) {
        throw new UOException();
    }
    
    /** 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.
     * @param index Index into this map.
     * @return The node at the indexth position in the map, or
     *   null if that is not a valid index.
     *
     */
    public Node item(int index) {
        return Wrapper.wrap((TreeObject)peer.get(index));
    }
    
    /** 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.
     * @param name The nodeName of the node to remove.
     * @return The node removed from this map if a node with such a name
     *   exists.
     * @exception 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.
     *
     */
    public Node removeNamedItem(String name) throws DOMException {
        throw new ROException();
    }
    
    /** 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.
     * @param namespaceURI The namespace URI of the node to remove.
     * @param localName The local name of the node to remove.
     * @return The node removed from this map if a node with such a local
     *   name and namespace URI exists.
     * @exception 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
     *
     */
    public Node removeNamedItemNS(String namespaceURI, String localName) throws DOMException {
        throw new ROException();
    }
    
    /** 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.
     * @param arg A node to store in this map. The node will later be
     *   accessible using the value of its nodeName attribute.
     * @return If the new Node replaces an existing node the
     *   replaced Node is returned, otherwise null
     *   is returned.
     * @exception 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.
     *
     */
    public Node setNamedItem(Node arg) throws DOMException {
        throw new ROException();
    }
    
    /** 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.
     * @param arg A node to store in this map. The node will later be
     *   accessible using the value of its namespaceURI and
     *   localName attributes.
     * @return If the new Node replaces an existing node the
     *   replaced Node is returned, otherwise null
     *   is returned.
     * @exception 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
     *
     */
    public Node setNamedItemNS(Node arg) throws DOMException {
        throw new ROException();
    }
    
}