All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.w3c.dom.NamedNodeMap Maven / Gradle / Ivy

Go to download

A library jar that provides APIs for Applications written for the Google Android Platform.

There is a newer version: 14-robolectric-10818077
Show newest version
/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom;

/**
 * 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 NodeList;
 * NamedNodeMaps 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.
 * 

NamedNodeMap objects in the DOM are live. *

See also the Document Object Model (DOM) Level 3 Core Specification. */ public interface NamedNodeMap { /** * 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); /** * 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. Replacing a node by itself has no effect. *
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; /** * 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; /** * 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); /** * The number of nodes in this map. The range of valid child node indices * is 0 to length-1 inclusive. */ public int getLength(); /** * Retrieves a node specified by local name and namespace URI. *
Per [XML Namespaces] * , applications must use the value null as the namespaceURI parameter * for methods if they wish to have no namespace. * @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. * @exception DOMException * NOT_SUPPORTED_ERR: May be raised if the implementation does not * support the feature "XML" and the language exposed through the * Document does not support XML Namespaces (such as [HTML 4.01]). * @since DOM Level 2 */ public Node getNamedItemNS(String namespaceURI, String localName) 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. Replacing a node by itself has no effect. *
Per [XML Namespaces] * , applications must use the value null as the namespaceURI parameter * for methods if they wish to have no namespace. * @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: May be raised if the implementation does not * support the feature "XML" and the language exposed through the * Document does not support XML Namespaces (such as [HTML 4.01]). * @since DOM Level 2 */ public Node setNamedItemNS(Node arg) 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. *
Per [XML Namespaces] * , applications must use the value null as the namespaceURI parameter * for methods if they wish to have no namespace. * @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. *
NOT_SUPPORTED_ERR: May be raised if the implementation does not * support the feature "XML" and the language exposed through the * Document does not support XML Namespaces (such as [HTML 4.01]). * @since DOM Level 2 */ public Node removeNamedItemNS(String namespaceURI, String localName) throws DOMException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy