# CharacterData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # CharacterData ``` interface CharacterData : Node ``` |--------------------------------------------------------------------------------------------------------| | [org.w3c.dom.CharacterData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#) | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Known Direct Subclasses [Comment](https://developer.android.com/reference/kotlin/org/w3c/dom/Comment),[Text](https://developer.android.com/reference/kotlin/org/w3c/dom/Text) |-------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Comment](https://developer.android.com/reference/kotlin/org/w3c/dom/Comment) | This interface inherits from`CharacterData`and represents the content of a comment, i. | | [Text](https://developer.android.com/reference/kotlin/org/w3c/dom/Text) | The`Text`interface inherits from`CharacterData`and represents the textual content (termed[character data](http://www.w3.org/TR/2004/REC-xml-20040204#syntax)in XML) of an`Element`or`Attr`. | | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Known Indirect Subclasses [CDATASection](https://developer.android.com/reference/kotlin/org/w3c/dom/CDATASection) |-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------| | [CDATASection](https://developer.android.com/reference/kotlin/org/w3c/dom/CDATASection) | CDATA sections are used to escape blocks of text containing characters that would otherwise be regarded as markup. | | The`CharacterData`interface extends Node with a set of attributes and methods for accessing character data in the DOM. For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to`CharacterData`, though`Text`and others do inherit the interface from it. All`offsets`in this interface start from`0`. As explained in the`DOMString`interface, text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term 16-bit units is used whenever necessary to indicate that indexing on CharacterData is done in 16-bit units. See also the[Document Object Model (DOM) Level 3 Core Specification](http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407). ## Summary | Inherited constants || |---|---| | From class[Node](https://developer.android.com/reference/kotlin/org/w3c/dom/Node) |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [ATTRIBUTE_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#ATTRIBUTE_NODE:kotlin.Short)
The node is an`Attr`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [CDATA_SECTION_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#CDATA_SECTION_NODE:kotlin.Short)
The node is a`CDATASection`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [COMMENT_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#COMMENT_NODE:kotlin.Short)
The node is a`Comment`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_FRAGMENT_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_FRAGMENT_NODE:kotlin.Short)
The node is a`DocumentFragment`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_NODE:kotlin.Short)
The node is a`Document`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_POSITION_CONTAINED_BY](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_POSITION_CONTAINED_BY:kotlin.Short)
The node is contained by the reference node. A node which is contained is always following, too.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_POSITION_CONTAINS](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_POSITION_CONTAINS:kotlin.Short)
The node contains the reference node. A node which contains is always preceding, too.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_POSITION_DISCONNECTED](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_POSITION_DISCONNECTED:kotlin.Short)
The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_POSITION_FOLLOWING](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_POSITION_FOLLOWING:kotlin.Short)
The node follows the reference node.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC:kotlin.Short)
The determination of preceding versus following is implementation-specific.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_POSITION_PRECEDING](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_POSITION_PRECEDING:kotlin.Short)
The second node precedes the reference node.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [DOCUMENT_TYPE_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#DOCUMENT_TYPE_NODE:kotlin.Short)
The node is a`DocumentType`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [ELEMENT_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#ELEMENT_NODE:kotlin.Short)
The node is an`Element`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [ENTITY_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#ENTITY_NODE:kotlin.Short)
The node is an`Entity`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [ENTITY_REFERENCE_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#ENTITY_REFERENCE_NODE:kotlin.Short)
The node is an`EntityReference`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [NOTATION_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#NOTATION_NODE:kotlin.Short)
The node is a`Notation`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [PROCESSING_INSTRUCTION_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#PROCESSING_INSTRUCTION_NODE:kotlin.Short)
The node is a`ProcessingInstruction`.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [TEXT_NODE](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#TEXT_NODE:kotlin.Short)
The node is a`Text`node.
| || | Public methods || |-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [appendData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#appendData(kotlin.String))`(`arg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Append the string to the end of the character data of the node. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [deleteData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#deleteData(kotlin.Int,%20kotlin.Int))`(`offset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `count:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Remove a range of 16-bit units from the node. | | abstract[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#getData())`()` The character data of the node that implements this interface. | | abstract[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getLength](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#getLength())`()` The number of 16-bit units that are available through`data`and the`substringData`method below. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [insertData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#insertData(kotlin.Int,%20kotlin.String))`(`offset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `arg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Insert a string at the specified 16-bit unit offset. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [replaceData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#replaceData(kotlin.Int,%20kotlin.Int,%20kotlin.String))`(`offset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `count:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `arg:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Replace the characters starting at the specified 16-bit unit offset with the specified string. | | abstract[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#setData(kotlin.String))`(`data:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` The character data of the node that implements this interface. | | abstract[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [substringData](https://developer.android.com/reference/kotlin/org/w3c/dom/CharacterData#substringData(kotlin.Int,%20kotlin.Int))`(`offset:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`, `count:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Extracts a range of data from the node. | | Inherited functions || |---|---| | From class[Node](https://developer.android.com/reference/kotlin/org/w3c/dom/Node) |------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [appendChild](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#appendChild(org.w3c.dom.Node))`(`newChild:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Adds the node`newChild`to the end of the list of children of this node. If the`newChild`is already in the tree, it is first removed.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [cloneNode](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#cloneNode(kotlin.Boolean))`(`deep:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)`
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent (`parentNode`is`null`) and no user data. User data associated to the imported node is not carried over. However, if any`UserDataHandlers`has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns. Cloning an`Element`copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any children it contains unless it is a deep clone. This includes text contained in an the`Element`since the text is contained in a child`Text`node. Cloning an`Attr`directly, as opposed to be cloned as part of an`Element`cloning operation, returns a specified attribute (`specified`is`true`). Cloning an`Attr`always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an`EntityReference`automatically constructs its subtree if a corresponding`Entity`is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node. Note that cloning an immutable subtree results in a mutable copy, but the children of an`EntityReference`clone are readonly . In addition, clones of unspecified`Attr`nodes are specified. And, cloning`Document`,`DocumentType`,`Entity`, and`Notation`nodes is implementation dependent.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [compareDocumentPosition](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#compareDocumentPosition(org.w3c.dom.Node))`(`other:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Compares the reference node, i.e. the node on which this method is being called, with a node, i.e. the one passed as a parameter, with regard to their position in the document and according to the document order.
| | [NamedNodeMap](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-named-node-map/index.html)! | [getAttributes](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getAttributes())`()`
A`NamedNodeMap`containing the attributes of this node (if it is an`Element`) or`null`otherwise.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getBaseURI](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getBaseURI())`()`
The absolute base URI of this node or`null`if the implementation wasn't able to obtain an absolute URI. This value is computed as described in . However, when the`Document`supports the feature "HTML" \[[DOM Level 2 HTML](http://www.w3.org/TR/2003/REC-DOM-Level-2-HTML-20030109)\] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the`documentURI`attribute from the`Document`interface otherwise.
| | [NodeList](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node-list/index.html)! | [getChildNodes](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getChildNodes())`()`
A`NodeList`that contains all children of this node. If there are no children, this is a`NodeList`containing no nodes.
| | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | [getFeature](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getFeature(kotlin.String,%20kotlin.String))`(`feature:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `version:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . The specialized object may also be obtained by using binding-specific casting methods but is not necessarily expected to, as discussed in . This method also allow the implementation to provide specialized objects which do not support the`Node`interface.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [getFirstChild](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getFirstChild())`()`
The first child of this node. If there is no such node, this returns`null`.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [getLastChild](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getLastChild())`()`
The last child of this node. If there is no such node, this returns`null`.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getLocalName](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getLocalName())`()`
Returns the local part of the qualified name of this node. For nodes of any type other than`ELEMENT_NODE`and`ATTRIBUTE_NODE`and nodes created with a DOM Level 1 method, such as`Document.createElement()`, this is always`null`.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getNamespaceURI](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getNamespaceURI())`()`
The namespace URI of this node, or`null`if it is unspecified (see ). This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time. For nodes of any type other than`ELEMENT_NODE`and`ATTRIBUTE_NODE`and nodes created with a DOM Level 1 method, such as`Document.createElement()`, this is always`null`. **Note:** Per the*Namespaces in XML* Specification \[[XML Namespaces](http://www.w3.org/TR/1999/REC-xml-names-19990114/)\] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [getNextSibling](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getNextSibling())`()`
The node immediately following this node. If there is no such node, this returns`null`.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getNodeName](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getNodeName())`()`
The name of this node, depending on its type; see the table above.
| | [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.html) | [getNodeType](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getNodeType())`()`
A code representing the type of the underlying object, as defined above.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getNodeValue](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getNodeValue())`()`
The value of this node, depending on its type; see the table above. When it is defined to be`null`, setting it has no effect, including if the node is read-only.
| | [Document](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-document/index.html)! | [getOwnerDocument](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getOwnerDocument())`()`
The`Document`object associated with this node. This is also the`Document`object used to create new nodes. When this node is a`Document`or a`DocumentType`which is not used with any`Document`yet, this is`null`.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [getParentNode](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getParentNode())`()`
The parent of this node. All nodes, except`Attr`,`Document`,`DocumentFragment`,`Entity`, and`Notation`may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is`null`.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getPrefix](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getPrefix())`()`
The namespace prefix of this node, or`null`if it is unspecified. When it is defined to be`null`, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the`nodeName`attribute, which holds the qualified name, as well as the`tagName`and`name`attributes of the`Element`and`Attr`interfaces, when applicable. Setting the prefix to`null`makes it unspecified, setting it to an empty string is implementation dependent. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the`namespaceURI`and`localName`do not change. For nodes of any type other than`ELEMENT_NODE`and`ATTRIBUTE_NODE`and nodes created with a DOM Level 1 method, such as`createElement`from the`Document`interface, this is always`null`.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [getPreviousSibling](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getPreviousSibling())`()`
The node immediately preceding this node. If there is no such node, this returns`null`.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getTextContent](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getTextContent())`()`
This attribute returns the text content of this node and its descendants. When it is defined to be`null`, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or`null`, replaced by a single`Text`node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute`Text.isElementContentWhitespace`). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content. The string returned is made of the text content of this node depending on its type, as defined below: | Node type | Content | |------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the`textContent`attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children. | | TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | `nodeValue` | | DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | *null* |

| | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | [getUserData](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#getUserData(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Retrieves the object associated to a key on a this node. The object must first have been set to this node by calling`setUserData`with the same key.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [hasAttributes](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#hasAttributes())`()`
Returns whether this node (if it is an element) has any attributes.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [hasChildNodes](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#hasChildNodes())`()`
Returns whether this node has any children.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [insertBefore](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#insertBefore(org.w3c.dom.Node,%20org.w3c.dom.Node))`(`newChild:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`, `refChild:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Inserts the node`newChild`before the existing child node`refChild`. If`refChild`is`null`, insert`newChild`at the end of the list of children. If`newChild`is a`DocumentFragment`object, all of its children are inserted, in the same order, before`refChild`. If the`newChild`is already in the tree, it is first removed. **Note:**Inserting a node before itself is implementation dependent.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isDefaultNamespace](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#isDefaultNamespace(kotlin.String))`(`namespaceURI:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
This method checks if the specified`namespaceURI`is the default namespace or not.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isEqualNode](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#isEqualNode(org.w3c.dom.Node))`(`arg:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Tests whether two nodes are equal. This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with`Node.isSameNode()`. All nodes that are the same will also be equal, though the reverse may not be true. Two nodes are equal if and only if the following conditions are satisfied: - The two nodes are of the same type. - The following string attributes are equal:`nodeName`,`localName`,`namespaceURI`,`prefix`,`nodeValue`. This is: they are both`null`, or they have the same length and are character for character identical. - The`attributes``NamedNodeMaps`are equal. This is: they are both`null`, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index. - The`childNodes``NodeLists`are equal. This is: they are both`null`, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For two`DocumentType`nodes to be equal, the following conditions must also be satisfied: - The following string attributes are equal:`publicId`,`systemId`,`internalSubset`. - The`entities``NamedNodeMaps`are equal. - The`notations``NamedNodeMaps`are equal.
On the other hand, the following do not affect equality: the`ownerDocument`,`baseURI`, and`parentNode`attributes, the`specified`attribute for`Attr`nodes, the`schemaTypeInfo`attribute for`Attr`and`Element`nodes, the`Text.isElementContentWhitespace`attribute for`Text`nodes, as well as any user data or event listeners registered on the nodes.
**Note:**As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isSameNode](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#isSameNode(org.w3c.dom.Node))`(`other:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Returns whether this node is the same node as the given one. This method provides a way to determine whether two`Node`references returned by the implementation reference the same object. When two`Node`references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isSupported](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#isSupported(kotlin.String,%20kotlin.String))`(`feature:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `version:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [lookupNamespaceURI](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#lookupNamespaceURI(kotlin.String))`(`prefix:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Look up the namespace URI associated to the given prefix, starting from this node. See for details on the algorithm used by this method.
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [lookupPrefix](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#lookupPrefix(kotlin.String))`(`namespaceURI:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
Look up the prefix associated to the given namespace URI, starting from this node. The default namespace declarations are ignored by this method. See for details on the algorithm used by this method.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [normalize](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#normalize())`()`
Puts all`Text`nodes in the full depth of the sub-tree underneath this`Node`, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates`Text`nodes, i.e., there are neither adjacent`Text`nodes nor empty`Text`nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer \[[XPointer](http://www.w3.org/TR/2003/REC-xptr-framework-20030325/)\] lookups) that depend on a particular document tree structure are to be used. If the parameter "normalize-characters" of the`DOMConfiguration`object attached to the`Node.ownerDocument`is`true`, this method will also fully normalize the characters of the`Text`nodes. **Note:** In cases where the document contains`CDATASections`, the normalize operation alone may not be sufficient, since XPointers do not differentiate between`Text`nodes and`CDATASection`nodes.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [removeChild](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#removeChild(org.w3c.dom.Node))`(`oldChild:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Removes the child node indicated by`oldChild`from the list of children, and returns it.
| | [Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)! | [replaceChild](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#replaceChild(org.w3c.dom.Node,%20org.w3c.dom.Node))`(`newChild:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`, `oldChild:` `[Node](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-node/index.html)!`)`
Replaces the child node`oldChild`with`newChild`in the list of children, and returns the`oldChild`node. If`newChild`is a`DocumentFragment`object,`oldChild`is replaced by all of the`DocumentFragment`children, which are inserted in the same order. If the`newChild`is already in the tree, it is first removed. **Note:**Replacing a node with itself is implementation dependent.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setNodeValue](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#setNodeValue(kotlin.String))`(`nodeValue:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
The value of this node, depending on its type; see the table above. When it is defined to be`null`, setting it has no effect, including if the node is read-only.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setPrefix](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#setPrefix(kotlin.String))`(`prefix:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
The namespace prefix of this node, or`null`if it is unspecified. When it is defined to be`null`, setting it has no effect, including if the node is read-only. Note that setting this attribute, when permitted, changes the`nodeName`attribute, which holds the qualified name, as well as the`tagName`and`name`attributes of the`Element`and`Attr`interfaces, when applicable. Setting the prefix to`null`makes it unspecified, setting it to an empty string is implementation dependent. Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the`namespaceURI`and`localName`do not change. For nodes of any type other than`ELEMENT_NODE`and`ATTRIBUTE_NODE`and nodes created with a DOM Level 1 method, such as`createElement`from the`Document`interface, this is always`null`.
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setTextContent](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#setTextContent(kotlin.String))`(`textContent:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)`
This attribute returns the text content of this node and its descendants. When it is defined to be`null`, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or`null`, replaced by a single`Text`node containing the string this attribute is set to. On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute`Text.isElementContentWhitespace`). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content. The string returned is made of the text content of this node depending on its type, as defined below: | Node type | Content | |------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the`textContent`attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children. | | TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | `nodeValue` | | DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | *null* |

| | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)! | [setUserData](https://developer.android.com/reference/kotlin/org/w3c/dom/Node#setUserData(kotlin.String,%20kotlin.Any,%20org.w3c.dom.UserDataHandler))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `data:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!`, `handler:` `[UserDataHandler](https://kotlinlang.org/api/latest/jvm/stdlib/org.w3c.dom/-user-data-handler/index.html)!`)`
Associate an object to a key on this node. The object can later be retrieved from this node by calling`getUserData`with the same key.
| || ## Public methods ### appendData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun appendData(arg: String!): Unit ``` Append the string to the end of the character data of the node. Upon success,`data`provides access to the concatenation of`data`and the`DOMString`specified. | Parameters || |-------|------------------------------------------------------------------------------------------------------------| | `arg` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The`DOMString`to append. | | Exceptions || |----------------------------|---------------------------------------------------------------| | `org.w3c.dom.DOMException` | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. | ### deleteData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun deleteData(     offset: Int,     count: Int ): Unit ``` Remove a range of 16-bit units from the node. Upon success,`data`and`length`reflect the change. | Parameters || |----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `offset` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The offset from which to start removing. | | `count` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The number of 16-bit units to delete. If the sum of`offset`and`count`exceeds`length`then all 16-bit units from`offset`to the end of the data are deleted. | | Exceptions || |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `org.w3c.dom.DOMException` | INDEX_SIZE_ERR: Raised if the specified`offset`is negative or greater than the number of 16-bit units in`data`, or if the specified`count`is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. | ### getData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun getData(): String! ``` The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a`CharacterData`node. However, implementation limits may mean that the entirety of a node's data may not fit into a single`DOMString`. In such cases, the user may call`substringData`to retrieve the data in appropriately sized pieces. | Exceptions || |----------------------------|----------------------------------------------------------------------------------------------------------------------------------| | `org.w3c.dom.DOMException` | DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a`DOMString`variable on the implementation platform. | ### getLength Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun getLength(): Int ``` The number of 16-bit units that are available through`data`and the`substringData`method below. This may have the value zero, i.e.,`CharacterData`nodes may be empty. ### insertData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun insertData(     offset: Int,     arg: String! ): Unit ``` Insert a string at the specified 16-bit unit offset. | Parameters || |----------|---------------------------------------------------------------------------------------------------------------------| | `offset` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The character offset at which to insert. | | `arg` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The`DOMString`to insert. | | Exceptions || |----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `org.w3c.dom.DOMException` | INDEX_SIZE_ERR: Raised if the specified`offset`is negative or greater than the number of 16-bit units in`data`. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. | ### replaceData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun replaceData(     offset: Int,     count: Int,     arg: String! ): Unit ``` Replace the characters starting at the specified 16-bit unit offset with the specified string. | Parameters || |----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `offset` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The offset from which to start replacing. | | `count` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The number of 16-bit units to replace. If the sum of`offset`and`count`exceeds`length`, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a`remove`method call with the same range, followed by an`append`method invocation). | | `arg` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:The`DOMString`with which the range must be replaced. | | Exceptions || |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `org.w3c.dom.DOMException` | INDEX_SIZE_ERR: Raised if the specified`offset`is negative or greater than the number of 16-bit units in`data`, or if the specified`count`is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. | ### setData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun setData(data: String!): Unit ``` The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a`CharacterData`node. However, implementation limits may mean that the entirety of a node's data may not fit into a single`DOMString`. In such cases, the user may call`substringData`to retrieve the data in appropriately sized pieces. | Exceptions || |----------------------------|----------------------------------------------------------------| | `org.w3c.dom.DOMException` | NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. | ### substringData Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` abstract fun substringData(     offset: Int,     count: Int ): String! ``` Extracts a range of data from the node. | Parameters || |----------|-------------------------------------------------------------------------------------------------------------------| | `offset` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Start offset of substring to extract. | | `count` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):The number of 16-bit units to extract. | | Return || |-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The specified substring. If the sum of`offset`and`count`exceeds the`length`, then all 16-bit units to the end of the data are returned. | | Exceptions || |----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `org.w3c.dom.DOMException` | INDEX_SIZE_ERR: Raised if the specified`offset`is negative or greater than the number of 16-bit units in`data`, or if the specified`count`is negative. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a`DOMString`. |