OpenJDK 27 · org.w3c.dom.Node · APIdia, the JavaDoc alternative

Interface table
Interface	nodeName	nodeValue	attributes
`Attr`	same as `Attr.name`	same as `Attr.value`	`null`
`CDATASection`	`"#cdata-section"`	same as `CharacterData.data`, the content of the CDATA Section	`null`
`Comment`	`"#comment"`	same as `CharacterData.data`, the content of the comment	`null`
`Document`	`"#document"`	`null`	`null`
`DocumentFragment`	`"#document-fragment"`	`null`	`null`
`DocumentType`	same as `DocumentType.name`	`null`	`null`
`Element`	same as `Element.tagName`	`null`	`NamedNodeMap`
`Entity`	entity name	`null`	`null`
`EntityReference`	name of entity referenced	`null`	`null`
`Notation`	notation name	`null`	`null`
`ProcessingInstruction`	same as `ProcessingInstruction.target`	same as `ProcessingInstruction.data`	`null`
`Text`	`"#text"`	same as `CharacterData.data`, the content of the text node	`null`

Modifier and Type	Field and Description
public static final short	ATTRIBUTE_NODE The node is an `Attr`.
public static final short	CDATA_SECTION_NODE The node is a `CDATASection`.
public static final short	COMMENT_NODE The node is a `Comment`.
public static final short	DOCUMENT_FRAGMENT_NODE The node is a `DocumentFragment`.
public static final short	DOCUMENT_NODE The node is a `Document`.
public static final short	DOCUMENT_POSITION_CONTAINED_BY The node is contained by the reference node.
public static final short	DOCUMENT_POSITION_CONTAINS The node contains the reference node.
public static final short	DOCUMENT_POSITION_DISCONNECTED The two nodes are disconnected.
public static final short	DOCUMENT_POSITION_FOLLOWING The node follows the reference node.
public static final short	DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC The determination of preceding versus following is implementation-specific.
public static final short	DOCUMENT_POSITION_PRECEDING The second node precedes the reference node.
public static final short	DOCUMENT_TYPE_NODE The node is a `DocumentType`.
public static final short	ELEMENT_NODE The node is an `Element`.
public static final short	ENTITY_NODE The node is an `Entity`.
public static final short	ENTITY_REFERENCE_NODE The node is an `EntityReference`.
public static final short	NOTATION_NODE The node is a `Notation`.
public static final short	PROCESSING_INSTRUCTION_NODE The node is a `ProcessingInstruction`.
public static final short	TEXT_NODE The node is a `Text` node.

Method Summary

Modifier and Type	Method and Description
public Node	Returns: The node added. appendChild(Node The node to add.If it is a `DocumentFragment` object, the entire contents of the document fragment are moved into the child list of this node newChild) Adds the node `newChild` to the end of the list of children of this node.
public Node	Returns: The duplicate node. cloneNode(boolean If `true`, recursively clone the subtree under the specified node; if `false`, clone only the node itself (and its attributes, if it is an `Element`). deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
public short	Returns: Returns how the node is positioned relatively to the reference node. compareDocumentPosition(Node The node to compare against the reference node. other) 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.
public NamedNodeMap	getAttributes() A `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise.
public String	getBaseURI() The absolute base URI of this node or `null` if the implementation wasn't able to obtain an absolute URI.
public NodeList	getChildNodes() A `NodeList` that contains all children of this node.
public Object	Returns: Returns an object which implements the specialized APIs of the specified feature and version, if any, or `null` if there is no object which implements interfaces associated with that feature. If the `DOMObject` returned by this method implements the `Node` interface, it must delegate to the primary core `Node` and not return results inconsistent with the primary core `Node` such as attributes, childNodes, etc. getFeature(String The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method. feature, String This is the version number of the feature to test. version) This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .
public Node	getFirstChild() The first child of this node.
public Node	getLastChild() The last child of this node.
public String	getLocalName() Returns the local part of the qualified name of this node.
public String	getNamespaceURI() The namespace URI of this node, or `null` if it is unspecified (see ).
public Node	getNextSibling() The node immediately following this node.
public String	getNodeName() The name of this node, depending on its type; see the table above.
public short	getNodeType() A code representing the type of the underlying object, as defined above.
public String	getNodeValue() The value of this node, depending on its type; see the table above.
public Document	getOwnerDocument() The `Document` object associated with this node.
public Node	getParentNode() The parent of this node.
public String	getPrefix() The namespace prefix of this node, or `null` if it is unspecified.
public Node	getPreviousSibling() The node immediately preceding this node.
public String	getTextContent() This attribute returns the text content of this node and its descendants.
public Object	Returns: Returns the `DOMUserData` associated to the given key on this node, or `null` if there was none. getUserData(String The key the object is associated to. key) Retrieves the object associated to a key on a this node.
public boolean	Returns: Returns `true` if this node has any attributes, `false` otherwise. hasAttributes() Returns whether this node (if it is an element) has any attributes.
public boolean	Returns: Returns `true` if this node has any children, `false` otherwise. hasChildNodes() Returns whether this node has any children.
public Node	Returns: The node being inserted. insertBefore(Node The node to insert. newChild, Node The reference node, i.e., the node before which the new node must be inserted. refChild) Inserts the node `newChild` before the existing child node `refChild`.
public boolean	Returns: Returns `true` if the specified `namespaceURI` is the default namespace, `false` otherwise. isDefaultNamespace(String The namespace URI to look for. namespaceURI) This method checks if the specified `namespaceURI` is the default namespace or not.
public boolean	Returns: Returns `true` if the nodes are equal, `false` otherwise. isEqualNode(Node The node to compare equality with. arg) Tests whether two nodes are equal.
public boolean	Returns: Returns `true` if the nodes are the same, `false` otherwise. isSameNode(Node The node to test against. other) Returns whether this node is the same node as the given one.
public boolean	Returns: Returns `true` if the specified feature is supported on this node, `false` otherwise. isSupported(String The name of the feature to test. feature, String This is the version number of the feature to test. version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .
public String	Returns: Returns the associated namespace URI or `null` if none is found. lookupNamespaceURI(String The prefix to look for. If this parameter is `null`, the method will return the default namespace URI if any. prefix) Look up the namespace URI associated to the given prefix, starting from this node.
public String	Returns: Returns an associated namespace prefix if found or `null` if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent. lookupPrefix(String The namespace URI to look for. namespaceURI) Look up the prefix associated to the given namespace URI, starting from this node.
public void	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.
public Node	Returns: The node removed. removeChild(Node The node being removed. oldChild) Removes the child node indicated by `oldChild` from the list of children, and returns it.
public Node	Returns: The node replaced. replaceChild(Node The new node to put in the child list. newChild, Node The node being replaced in the list. oldChild) Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node.
public void	setNodeValue(String nodeValue) The value of this node, depending on its type; see the table above.
public void	setPrefix(String prefix) The namespace prefix of this node, or `null` if it is unspecified.
public void	setTextContent(String textContent) This attribute returns the text content of this node and its descendants.
public Object	Returns: Returns the `DOMUserData` previously associated to the given key on this node, or `null` if there was none. setUserData(String The key to associate the object to. key, Object The object to associate to the given key, or `null` to remove any existing association to that key. data, UserDataHandler The handler to associate to that key, or `null`. handler) Associate an object to a key on this node.

ATTRIBUTE_NODE	back to summary
public static final short ATTRIBUTE_NODE The node is an `Attr`.

CDATA_SECTION_NODE	back to summary
public static final short CDATA_SECTION_NODE The node is a `CDATASection`.

COMMENT_NODE	back to summary
public static final short COMMENT_NODE The node is a `Comment`.

DOCUMENT_FRAGMENT_NODE	back to summary
public static final short DOCUMENT_FRAGMENT_NODE The node is a `DocumentFragment`.

DOCUMENT_NODE	back to summary
public static final short DOCUMENT_NODE The node is a `Document`.

DOCUMENT_POSITION_CONTAINED_BY	back to summary
public static final short DOCUMENT_POSITION_CONTAINED_BY The node is contained by the reference node. A node which is contained is always following, too.

DOCUMENT_POSITION_CONTAINS	back to summary
public static final short DOCUMENT_POSITION_CONTAINS The node contains the reference node. A node which contains is always preceding, too.

DOCUMENT_POSITION_DISCONNECTED	back to summary
public static final short DOCUMENT_POSITION_DISCONNECTED The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.

DOCUMENT_POSITION_FOLLOWING	back to summary
public static final short DOCUMENT_POSITION_FOLLOWING The node follows the reference node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC	back to summary
public static final short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC The determination of preceding versus following is implementation-specific.

DOCUMENT_POSITION_PRECEDING	back to summary
public static final short DOCUMENT_POSITION_PRECEDING The second node precedes the reference node.

DOCUMENT_TYPE_NODE	back to summary
public static final short DOCUMENT_TYPE_NODE The node is a `DocumentType`.

ELEMENT_NODE	back to summary
public static final short ELEMENT_NODE The node is an `Element`.

ENTITY_NODE	back to summary
public static final short ENTITY_NODE The node is an `Entity`.

ENTITY_REFERENCE_NODE	back to summary
public static final short ENTITY_REFERENCE_NODE The node is an `EntityReference`.

NOTATION_NODE	back to summary
public static final short NOTATION_NODE The node is a `Notation`.

PROCESSING_INSTRUCTION_NODE	back to summary
public static final short PROCESSING_INSTRUCTION_NODE The node is a `ProcessingInstruction`.

TEXT_NODE	back to summary
public static final short TEXT_NODE The node is a `Text` node.

Method Detail

appendChild back to summary

appendChild	back to summary
public Node appendChild(Node newChild) throws DOMException 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. Parameters newChild:Node The node to add.If it is a `DocumentFragment` object, the entire contents of the document fragment are moved into the child list of this node Returns:Node The node added. Exceptions DOMException: HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the `newChild` node, or if the node to append is one of this node's ancestors or this node itself, or if this node is of type `Document` and the DOM application attempts to append a second `DocumentType` or `Element` node. WRONG_DOCUMENT_ERR: Raised if `newChild` was created from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly. NOT_SUPPORTED_ERR: if the `newChild` node is a child of the `Document` node, this exception might be raised if the DOM implementation doesn't support the removal of the `DocumentType` child or `Element` child. Since 1.4, DOM Level 3

public Node appendChild(Node newChild) throws DOMException

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.

Parameters

newChild:Node: The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node

Returns:Node

The node added.

Exceptions

DOMException:: HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to append a second DocumentType or Element node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.
NOT_SUPPORTED_ERR: if the newChild node is a child of the Document node, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or Element child.

Since

1.4, DOM Level 3

cloneNode back to summary

cloneNode	back to summary
public Node cloneNode(boolean deep) 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. Parameters deep:boolean If `true`, recursively clone the subtree under the specified node; if `false`, clone only the node itself (and its attributes, if it is an `Element`). Returns:Node The duplicate node.

public Node cloneNode(boolean deep)

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.

Parameters

deep:boolean: If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Returns:Node

The duplicate node.

compareDocumentPosition	back to summary
public short compareDocumentPosition(Node other) throws DOMException 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. Parameters other:Node The node to compare against the reference node. Returns:short Returns how the node is positioned relatively to the reference node. Exceptions DOMException: NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results. Since 1.5, DOM Level 3

compareDocumentPosition

back to summary

public short compareDocumentPosition(Node other) throws DOMException

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.

Parameters

other:Node: The node to compare against the reference node.

Returns:short

Returns how the node is positioned relatively to the reference node.

Exceptions

DOMException:: NOT_SUPPORTED_ERR: when the compared nodes are from different DOM implementations that do not coordinate to return consistent implementation-specific results.

Since

1.5, DOM Level 3

getAttributes	back to summary
public NamedNodeMap getAttributes() A `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `null` otherwise.

getBaseURI back to summary

getBaseURI	back to summary
public String 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] , 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. Since 1.5, DOM Level 3

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

Since: 1.5, DOM Level 3

getChildNodes	back to summary
public NodeList getChildNodes() A `NodeList` that contains all children of this node. If there are no children, this is a `NodeList` containing no nodes.

getFeature back to summary

getFeature	back to summary
public Object getFeature(String feature, String version) 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. Parameters feature:String The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method. version:String This is the version number of the feature to test. Returns:Object Returns an object which implements the specialized APIs of the specified feature and version, if any, or `null` if there is no object which implements interfaces associated with that feature. If the `DOMObject` returned by this method implements the `Node` interface, it must delegate to the primary core `Node` and not return results inconsistent with the primary core `Node` such as attributes, childNodes, etc. Since 1.5, DOM Level 3

public Object getFeature(String feature, String version)

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.

Parameters

feature:String: The name of the feature requested. Note that any plus sign "+" prepended to the name of the feature will be ignored since it is not significant in the context of this method.
version:String: This is the version number of the feature to test.

Returns:Object

Returns an object which implements the specialized APIs of the specified feature and version, if any, or null if there is no object which implements interfaces associated with that feature. If the DOMObject returned by this method implements the Node interface, it must delegate to the primary core Node and not return results inconsistent with the primary core Node such as attributes, childNodes, etc.

Since

1.5, DOM Level 3

getFirstChild	back to summary
public Node getFirstChild() The first child of this node. If there is no such node, this returns `null`.

getLastChild	back to summary
public Node getLastChild() The last child of this node. If there is no such node, this returns `null`.

getLocalName back to summary

getLocalName	back to summary
public String 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`. Since 1.4, DOM Level 2

public String 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.

Since: 1.4, DOM Level 2

getNamespaceURI back to summary

getNamespaceURI	back to summary
public String 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] 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. Since 1.4, DOM Level 2

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

Since: 1.4, DOM Level 2

getNextSibling	back to summary
public Node getNextSibling() The node immediately following this node. If there is no such node, this returns `null`.

getNodeName	back to summary
public String getNodeName() The name of this node, depending on its type; see the table above.

getNodeType	back to summary
public short getNodeType() A code representing the type of the underlying object, as defined above.

getNodeValue back to summary

getNodeValue	back to summary
public String getNodeValue() throws DOMException 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. Exceptions DOMException: DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a `DOMString` variable on the implementation platform.

public String getNodeValue() throws DOMException

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.

Exceptions

DOMException:: DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

getOwnerDocument back to summary

getOwnerDocument	back to summary
public Document 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`. Since 1.4, DOM Level 2

public Document 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.

Since: 1.4, DOM Level 2

getParentNode	back to summary
public 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`.

getPrefix back to summary

getPrefix	back to summary
public String 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`. Since 1.4, DOM Level 2

public String 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.

Since: 1.4, DOM Level 2

getPreviousSibling	back to summary
public Node getPreviousSibling() The node immediately preceding this node. If there is no such node, this returns `null`.

getTextContent back to summary

public String getTextContent() throws DOMException

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/Content table
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

Exceptions

DOMException:: DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

Since

1.5, DOM Level 3

getUserData back to summary

getUserData	back to summary
public Object getUserData(String key) 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. Parameters key:String The key the object is associated to. Returns:Object Returns the `DOMUserData` associated to the given key on this node, or `null` if there was none. Since 1.5, DOM Level 3

public Object getUserData(String key)

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.

Parameters

key:String: The key the object is associated to.

Returns:Object

Returns the DOMUserData associated to the given key on this node, or null if there was none.

Since

1.5, DOM Level 3

hasAttributes back to summary

hasAttributes	back to summary
public boolean hasAttributes() Returns whether this node (if it is an element) has any attributes. Returns:boolean Returns `true` if this node has any attributes, `false` otherwise. Since 1.4, DOM Level 2

public boolean hasAttributes()

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

Returns:boolean: Returns true if this node has any attributes, false otherwise.
Since: 1.4, DOM Level 2

hasChildNodes back to summary

hasChildNodes	back to summary
public boolean hasChildNodes() Returns whether this node has any children. Returns:boolean Returns `true` if this node has any children, `false` otherwise.

public boolean hasChildNodes()

Returns whether this node has any children.

Returns:boolean: Returns true if this node has any children, false otherwise.

insertBefore back to summary

insertBefore	back to summary
public Node insertBefore(Node newChild, Node refChild) throws DOMException 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. Parameters newChild:Node The node to insert. refChild:Node The reference node, i.e., the node before which the new node must be inserted. Returns:Node The node being inserted. Exceptions DOMException: HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the `newChild` node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of type `Document` and the DOM application attempts to insert a second `DocumentType` or `Element` node. WRONG_DOCUMENT_ERR: Raised if `newChild` was created from a different document than the one that created this node. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly. NOT_FOUND_ERR: Raised if `refChild` is not a child of this node. NOT_SUPPORTED_ERR: if this node is of type `Document`, this exception might be raised if the DOM implementation doesn't support the insertion of a `DocumentType` or `Element` node. Since 1.4, DOM Level 3

public Node insertBefore(Node newChild, Node refChild) throws DOMException

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.

Parameters

newChild:Node: The node to insert.
refChild:Node: The reference node, i.e., the node before which the new node must be inserted.

Returns:Node

The node being inserted.

Exceptions

DOMException:: HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to insert a second DocumentType or Element node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the insertion of a DocumentType or Element node.

Since

1.4, DOM Level 3

isDefaultNamespace back to summary

isDefaultNamespace	back to summary
public boolean isDefaultNamespace(String namespaceURI) This method checks if the specified `namespaceURI` is the default namespace or not. Parameters namespaceURI:String The namespace URI to look for. Returns:boolean Returns `true` if the specified `namespaceURI` is the default namespace, `false` otherwise. Since 1.5, DOM Level 3

public boolean isDefaultNamespace(String namespaceURI)

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

Parameters

namespaceURI:String: The namespace URI to look for.

Returns:boolean

Returns true if the specified namespaceURI is the default namespace, false otherwise.

Since

1.5, DOM Level 3

isEqualNode back to summary

isEqualNode	back to summary
public boolean isEqualNode(Node arg) 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. Parameters arg:Node The node to compare equality with. Returns:boolean Returns `true` if the nodes are equal, `false` otherwise. Since 1.5, DOM Level 3

public boolean isEqualNode(Node arg)

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.

Parameters

arg:Node: The node to compare equality with.

Returns:boolean

Returns true if the nodes are equal, false otherwise.

Since

1.5, DOM Level 3

isSameNode back to summary

isSameNode	back to summary
public boolean isSameNode(Node other) 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. Parameters other:Node The node to test against. Returns:boolean Returns `true` if the nodes are the same, `false` otherwise. Since 1.5, DOM Level 3

public boolean isSameNode(Node other)

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.

Parameters

other:Node: The node to test against.

Returns:boolean

Returns true if the nodes are the same, false otherwise.

Since

1.5, DOM Level 3

isSupported back to summary

isSupported	back to summary
public boolean isSupported(String feature, String version) Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in . Parameters feature:String The name of the feature to test. version:String This is the version number of the feature to test. Returns:boolean Returns `true` if the specified feature is supported on this node, `false` otherwise. Since 1.4, DOM Level 2

public boolean isSupported(String feature, String version)

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

Parameters

feature:String: The name of the feature to test.
version:String: This is the version number of the feature to test.

Returns:boolean

Returns true if the specified feature is supported on this node, false otherwise.

Since

1.4, DOM Level 2

lookupNamespaceURI back to summary

public String lookupNamespaceURI(String prefix)

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

Parameters

prefix:String: The prefix to look for. If this parameter is null, the method will return the default namespace URI if any.

Returns:String

Returns the associated namespace URI or null if none is found.

Since

1.5, DOM Level 3

lookupPrefix back to summary

public String lookupPrefix(String namespaceURI)

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.

Parameters

namespaceURI:String: The namespace URI to look for.

Returns:String

Returns an associated namespace prefix if found or null if none is found. If more than one prefix are associated to the namespace prefix, the returned namespace prefix is implementation dependent.

Since

1.5, DOM Level 3

normalize back to summary

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

Since: 1.4, DOM Level 3

removeChild back to summary

public Node removeChild(Node oldChild) throws DOMException

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

Parameters

oldChild:Node: The node being removed.

Returns:Node

The node removed.

Exceptions

DOMException:: NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or the Element child.

Since

1.4, DOM Level 3

replaceChild back to summary

public Node replaceChild(Node newChild, Node oldChild) throws DOMException

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.

Parameters

newChild:Node: The new node to put in the child list.
oldChild:Node: The node being replaced in the list.

Returns:Node

The node replaced.

Exceptions

DOMException:: HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself, or if this node is of type Document and the result of the replacement operation would add a second DocumentType or Element on the Document node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the replacement of the DocumentType child or Element child.

Since

1.4, DOM Level 3

setNodeValue back to summary

public void setNodeValue(String nodeValue) throws DOMException

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.

Exceptions

DOMException:: NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to be null.

setPrefix back to summary

public void setPrefix(String prefix) throws DOMException

Exceptions

DOMException:: INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in the Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from " http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" [XML Namespaces] .

Since

1.4, DOM Level 2

setTextContent back to summary

public void setTextContent(String textContent) throws DOMException

Node/Content table
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

Exceptions

DOMException:: NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Since

1.5, DOM Level 3

setUserData back to summary

public Object setUserData(String key, Object data, UserDataHandler handler)

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.

Parameters

key:String: The key to associate the object to.
data:Object: The object to associate to the given key, or null to remove any existing association to that key.
handler:UserDataHandler: The handler to associate to that key, or null.

Returns:Object

Returns the DOMUserData previously associated to the given key on this node, or null if there was none.

Since

1.5, DOM Level 3

public Interface Node

Field Summary

Method Summary

Field Detail

Method Detail