1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (c) 2000 World Wide Web Consortium, 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * (Massachusetts Institute of Technology, Institut National de 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Recherche en Informatique et en Automatique, Keio University). All 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Rights Reserved. This program is distributed under the W3C's Software 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Intellectual Property License. This program is distributed in the 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * hope that it will be useful, but WITHOUT ANY WARRANTY; without even 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * PURPOSE. 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See W3C License http://www.w3.org/Consortium/Legal/ for more details. 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage org.w3c.dom; 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project// BEGIN android-note 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project// Cleaned up @param tags that seemed to be missing spaces between 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project// the parameter name and the start of the description. 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project// END android-note 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project//BEGIN android-note 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project//Filled some gaps in the documentation and refactored parts of the existing 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project//documentation to make the Doclet happy. 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project//END android-note 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Objects implementing the <code>NamedNodeMap</code> interface are used to 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * represent collections of nodes that can be accessed by name. Note that 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>NamedNodeMap</code> does not inherit from <code>NodeList</code>; 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>NamedNodeMaps</code> are not maintained in any particular order. 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Objects contained in an object implementing <code>NamedNodeMap</code> may 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * also be accessed by an ordinal index, but this is simply to allow 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * convenient enumeration of the contents of a <code>NamedNodeMap</code>, 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * and does not imply that the DOM specifies an order to these Nodes. 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p><code>NamedNodeMap</code> objects in the DOM are live. 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>. 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 37f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpublic interface NamedNodeMap { 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Retrieves a node specified by name. 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param name The <code>nodeName</code> of a node to retrieve. 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return A <code>Node</code> (of any type) with the specified 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>nodeName</code>, or <code>null</code> if it does not identify 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * any node in this map. 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node getNamedItem(String name); 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Adds a node using its <code>nodeName</code> attribute. If a node with 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * that name is already present in this map, it is replaced by the new 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * one. 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>As the <code>nodeName</code> attribute is used to derive the name 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * which the node must be stored under, multiple nodes of certain types 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * (those that have a "special" string value) cannot be stored as the 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * names would clash. This is seen as preferable to allowing nodes to be 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * aliased. 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param arg A node to store in this map. The node will later be 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * accessible using the value of its <code>nodeName</code> attribute. 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return If the new <code>Node</code> replaces an existing node the 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * replaced <code>Node</code> is returned, otherwise <code>null</code> 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * is returned. 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @exception DOMException 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * different document than the one that created this map. 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>Attr</code> that is already an attribute of another 67f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>Element</code> object. The DOM user must explicitly clone 68f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>Attr</code> nodes to re-use them in other elements. 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node setNamedItem(Node arg) 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throws DOMException; 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Removes a node specified by name. When this map contains the attributes 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * attached to an element, if the removed attribute is known to have a 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * default value, an attribute immediately appears containing the 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * default value as well as the corresponding namespace URI, local name, 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * and prefix when applicable. 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param name The <code>nodeName</code> of the node to remove. 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return The node removed from this map if a node with such a name 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * exists. 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @exception DOMException 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * this map. 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node removeNamedItem(String name) 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throws DOMException; 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Returns the <code>index</code>th item in the map. If <code>index</code> 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * is greater than or equal to the number of nodes in this map, this 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * returns <code>null</code>. 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param index Index into this map. 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return The node at the <code>index</code>th position in the map, or 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>null</code> if that is not a valid index. 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node item(int index); 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * The number of nodes in this map. The range of valid child node indices 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * is <code>0</code> to <code>length-1</code> inclusive. 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the length of the map. 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int getLength(); 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Retrieves a node specified by local name and namespace URI. HTML-only 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * DOM implementations do not need to implement this method. 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param namespaceURI The namespace URI of the node to retrieve. 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param localName The local name of the node to retrieve. 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return A <code>Node</code> (of any type) with the specified local 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * name and namespace URI, or <code>null</code> if they do not 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * identify any node in this map. 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @since DOM Level 2 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node getNamedItemNS(String namespaceURI, 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project String localName); 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Adds a node using its <code>namespaceURI</code> and 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>localName</code>. If a node with that namespace URI and that 124f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * local name is already present in this map, it is replaced by the new 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * one. 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>HTML-only DOM implementations do not need to implement this method. 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param arg A node to store in this map. The node will later be 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * accessible using the value of its <code>namespaceURI</code> and 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>localName</code> attributes. 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return If the new <code>Node</code> replaces an existing node the 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * replaced <code>Node</code> is returned, otherwise <code>null</code> 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * is returned. 133f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @exception DOMException 134f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a 135f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * different document than the one that created this map. 136f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. 137f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an 138f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>Attr</code> that is already an attribute of another 139f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>Element</code> object. The DOM user must explicitly clone 140f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>Attr</code> nodes to re-use them in other elements. 141f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @since DOM Level 2 142f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 143f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node setNamedItemNS(Node arg) 144f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throws DOMException; 145f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 146f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 147f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Removes a node specified by local name and namespace URI. A removed 148f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * attribute may be known to have a default value when this map contains 149f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * the attributes attached to an element, as returned by the attributes 150f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * attribute of the <code>Node</code> interface. If so, an attribute 151f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * immediately appears containing the default value as well as the 152f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * corresponding namespace URI, local name, and prefix when applicable. 153f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>HTML-only DOM implementations do not need to implement this method. 154f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param namespaceURI The namespace URI of the node to remove. 155f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param localName The local name of the node to remove. 156f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return The node removed from this map if a node with such a local 157f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * name and namespace URI exists. 158f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @exception DOMException 159f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * NOT_FOUND_ERR: Raised if there is no node with the specified 160f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <code>namespaceURI</code> and <code>localName</code> in this map. 161f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly. 162f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @since DOM Level 2 163f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 164f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public Node removeNamedItemNS(String namespaceURI, 165f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project String localName) 166f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throws DOMException; 167f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 168f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 169