Node

ATTRIBUTE_NODE

static val ATTRIBUTE_NODE: Short

The node is an Attr.

Value: 2

CDATA_SECTION_NODE

static val CDATA_SECTION_NODE: Short

The node is a CDATASection.

Value: 4

COMMENT_NODE

static val COMMENT_NODE: Short

The node is a Comment.

Value: 8

DOCUMENT_FRAGMENT_NODE

static val DOCUMENT_FRAGMENT_NODE: Short

The node is a DocumentFragment.

Value: 11

DOCUMENT_NODE

static val DOCUMENT_NODE: Short

The node is a Document.

Value: 9

DOCUMENT_POSITION_CONTAINED_BY

static val DOCUMENT_POSITION_CONTAINED_BY: Short

The node is contained by the reference node. A node which is contained is always following, too.

Value: 16

DOCUMENT_POSITION_CONTAINS

static val DOCUMENT_POSITION_CONTAINS: Short

The node contains the reference node. A node which contains is always preceding, too.

Value: 8

DOCUMENT_POSITION_DISCONNECTED

static val DOCUMENT_POSITION_DISCONNECTED: Short

The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.

Value: 1

DOCUMENT_POSITION_FOLLOWING

static val DOCUMENT_POSITION_FOLLOWING: Short

The node follows the reference node.

Value: 4

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

static val DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: Short

The determination of preceding versus following is implementation-specific.

Value: 32

DOCUMENT_POSITION_PRECEDING

static val DOCUMENT_POSITION_PRECEDING: Short

The second node precedes the reference node.

Value: 2

DOCUMENT_TYPE_NODE

static val DOCUMENT_TYPE_NODE: Short

The node is a DocumentType.

Value: 10

ELEMENT_NODE

static val ELEMENT_NODE: Short

The node is an Element.

Value: 1

ENTITY_NODE

static val ENTITY_NODE: Short

The node is an Entity.

Value: 6

ENTITY_REFERENCE_NODE

static val ENTITY_REFERENCE_NODE: Short

The node is an EntityReference.

Value: 5

NOTATION_NODE

static val NOTATION_NODE: Short

The node is a Notation.

Value: 12

PROCESSING_INSTRUCTION_NODE

static val PROCESSING_INSTRUCTION_NODE: Short

The node is a ProcessingInstruction.

Value: 7

TEXT_NODE

static val TEXT_NODE: Short

The node is a Text node.

Value: 3

appendChild

abstract fun appendChild(newChild: Node!): Node!

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.

cloneNode

abstract fun cloneNode(deep: Boolean): Node!

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.

compareDocumentPosition

abstract fun compareDocumentPosition(other: Node!): Short

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.

getAttributes

abstract fun getAttributes(): NamedNodeMap!

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

getBaseURI

abstract fun getBaseURI(): String!

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] , 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.

getChildNodes

abstract fun getChildNodes(): NodeList!

A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

getFeature

abstract fun getFeature(
    feature: String!, 
    version: String!
): Any!

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.

getFirstChild

abstract fun getFirstChild(): Node!

The first child of this node. If there is no such node, this returns null.

getLastChild

abstract fun getLastChild(): Node!

The last child of this node. If there is no such node, this returns null.

getLocalName

abstract fun getLocalName(): String!

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.

getNamespaceURI

abstract fun getNamespaceURI(): String!

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] 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.

getNextSibling

abstract fun getNextSibling(): Node!

The node immediately following this node. If there is no such node, this returns null.

getNodeName

abstract fun getNodeName(): String!

The name of this node, depending on its type; see the table above.

getNodeType

abstract fun getNodeType(): Short

A code representing the type of the underlying object, as defined above.

getNodeValue

abstract fun getNodeValue(): String!

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.

getOwnerDocument

abstract fun getOwnerDocument(): Document!

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.

getParentNode

abstract fun getParentNode(): Node!

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.

getPrefix

abstract fun getPrefix(): String!

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.

getPreviousSibling

abstract fun getPreviousSibling(): Node!

The node immediately preceding this node. If there is no such node, this returns null.

getTextContent

abstract fun getTextContent(): String!

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:

getUserData

abstract fun getUserData(key: String!): Any!

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.

hasAttributes

abstract fun hasAttributes(): Boolean

Returns whether this node (if it is an element) has any attributes.

hasChildNodes

abstract fun hasChildNodes(): Boolean

Returns whether this node has any children.

insertBefore

abstract fun insertBefore(
    newChild: Node!, 
    refChild: Node!
): Node!

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.

isDefaultNamespace

abstract fun isDefaultNamespace(namespaceURI: String!): Boolean

This method checks if the specified namespaceURI is the default namespace or not.

isEqualNode

abstract fun isEqualNode(arg: Node!): Boolean

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.

• The following string attributes are equal: publicId, systemId, internalSubset.
• The entities NamedNodeMaps are equal.
• The notations NamedNodeMaps are equal.

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.

isSameNode

abstract fun isSameNode(other: Node!): Boolean

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.

isSupported

abstract fun isSupported(
    feature: String!, 
    version: String!
): Boolean

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .

lookupNamespaceURI

abstract fun lookupNamespaceURI(prefix: String!): String!

Look up the namespace URI associated to the given prefix, starting from this node.
See for details on the algorithm used by this method.

lookupPrefix

abstract fun lookupPrefix(namespaceURI: String!): String!

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.

normalize

abstract fun normalize(): Unit

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] 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.

removeChild

abstract fun removeChild(oldChild: Node!): Node!

Removes the child node indicated by oldChild from the list of children, and returns it.

replaceChild

abstract fun replaceChild(
    newChild: Node!, 
    oldChild: Node!
): Node!

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.

setNodeValue

abstract fun setNodeValue(nodeValue: String!): Unit

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.

setPrefix

abstract fun setPrefix(prefix: String!): Unit

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.

setTextContent

abstract fun setTextContent(textContent: String!): Unit

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:

setUserData

abstract fun setUserData(
    key: String!, 
    data: Any!, 
    handler: UserDataHandler!
): Any!

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.