Added in API level 1

Attr

interface Attr : Node

org.w3c.dom.Attr

The Attr interface represents an attribute in an Element object. Typically the allowable values for the attribute are defined in a schema associated with the document.

Attr objects inherit the Node interface, but since they are not actually child nodes of the element they describe, the DOM does not consider them part of the document tree. Thus, the Node attributes parentNode, previousSibling, and nextSibling have a null value for Attr objects. The DOM takes the view that attributes are properties of elements rather than having a separate identity from the elements they are associated with; this should make it more efficient to implement such features as default attributes associated with all elements of a given type. Furthermore, Attr nodes may not be immediate children of a DocumentFragment. However, they can be associated with Element nodes contained within a DocumentFragment. In short, users and implementors of the DOM need to be aware that Attr nodes have some things in common with other objects inheriting the Node interface, but they also are quite distinct.

The attribute's effective value is determined as follows: if this attribute has been explicitly assigned any value, that value is the attribute's effective value; otherwise, if there is a declaration for this attribute, and that declaration includes a default value, then that default value is the attribute's effective value; otherwise, the attribute does not exist on this element in the structure model until it has been explicitly added. Note that the Node.nodeValue attribute on the Attr instance can also be used to retrieve the string version of the attribute's value(s).

If the attribute was not explicitly given a value in the instance document but has a default value provided by the schema associated with the document, an attribute node will be created with specified set to false. Removing attribute nodes for which a default value is defined in the schema generates a new attribute node with the default value and specified set to false. If validation occurred while invoking Document.normalizeDocument(), attribute nodes with specified equals to false are recomputed according to the default attribute values provided by the schema. If no default value is associate with this attribute in the schema, the attribute node is discarded.

In XML, where the value of an attribute can contain entity references, the child nodes of the Attr node may be either Text or EntityReference nodes (when these are in use; see the description of EntityReference for discussion).

The DOM Core represents all attribute values as simple strings, even if the DTD or schema associated with the document declares them of some specific type such as tokenized.

The way attribute value normalization is performed by the DOM implementation depends on how much the implementation knows about the schema in use. Typically, the value and nodeValue attributes of an Attr node initially returns the normalized value given by the parser. It is also the case after Document.normalizeDocument() is called (assuming the right options have been set). But this may not be the case after mutation, independently of whether the mutation is performed by setting the string value directly or by changing the Attr child nodes. In particular, this is true when character references are involved, given that they are not represented in the DOM and they impact attribute value normalization. On the other hand, if the implementation knows about the schema in use when the attribute value is changed, and it is of a different type than CDATA, it may normalize it again at that time. This is especially true of specialized DOM implementations, such as SVG DOM implementations, which store attribute values in an internal form different from a string.

The following table gives some examples of the relations between the attribute value in the original document (parsed attribute), the value as exposed in the DOM, and the serialization of the value:

Examples	Parsed attribute value	Initial `Attr.value`	Serialized attribute value
Character reference	"x²=5"	"x\u00b2=5"	"x²=5"
Built-in character entity	"y<6"	"y<6"	"y<6"
Literal newline between	"x=5 y=6"	"x=5 y=6"	"x=5 y=6"
Normalized newline between	"x=5 y=6"	"x=5 y=6"	"x=5 y=6"
Entity `e` with literal newline	<!ENTITY e '... ...'> [...]> "x=5&e;y=6"	Dependent on Implementation and Load Options	Dependent on Implementation and Load/Save Options

Summary

Inherited constants

From class Node

`Short`	`ATTRIBUTE_NODE` The node is an `Attr`.
`Short`	`CDATA_SECTION_NODE` The node is a `CDATASection`.
`Short`	`COMMENT_NODE` The node is a `Comment`.
`Short`	`DOCUMENT_FRAGMENT_NODE` The node is a `DocumentFragment`.
`Short`	`DOCUMENT_NODE` The node is a `Document`.
`Short`	`DOCUMENT_POSITION_CONTAINED_BY` The node is contained by the reference node. A node which is contained is always following, too.
`Short`	`DOCUMENT_POSITION_CONTAINS` The node contains the reference node. A node which contains is always preceding, too.
`Short`	`DOCUMENT_POSITION_DISCONNECTED` The two nodes are disconnected. Order between disconnected nodes is always implementation-specific.
`Short`	`DOCUMENT_POSITION_FOLLOWING` The node follows the reference node.
`Short`	`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC` The determination of preceding versus following is implementation-specific.
`Short`	`DOCUMENT_POSITION_PRECEDING` The second node precedes the reference node.
`Short`	`DOCUMENT_TYPE_NODE` The node is a `DocumentType`.
`Short`	`ELEMENT_NODE` The node is an `Element`.
`Short`	`ENTITY_NODE` The node is an `Entity`.
`Short`	`ENTITY_REFERENCE_NODE` The node is an `EntityReference`.
`Short`	`NOTATION_NODE` The node is a `Notation`.
`Short`	`PROCESSING_INSTRUCTION_NODE` The node is a `ProcessingInstruction`.
`Short`	`TEXT_NODE` The node is a `Text` node.

Public methods
abstract String!	`getName()` Returns the name of this attribute.
abstract Element!	`getOwnerElement()` The `Element` node this attribute is attached to or `null` if this attribute is not in use.
abstract TypeInfo!	`getSchemaTypeInfo()` The type information associated with this attribute.
abstract Boolean	`getSpecified()` `True` if this attribute was explicitly given a value in the instance document, `false` otherwise.
abstract String!	`getValue()` On retrieval, the value of the attribute is returned as a string.
abstract Boolean	`isId()` Returns whether this attribute is known to be of type ID (i.e. to contain an identifier for its owner element) or not.
abstract Unit	`setValue(value: String!)` On retrieval, the value of the attribute is returned as a string.

Inherited functions

From class Node

Node!

appendChild(newChild: 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.

Node!

cloneNode(deep: Boolean)

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

compareDocumentPosition(other: Node!)

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!

getAttributes()

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

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.

NodeList!

getChildNodes()

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

Any!

getFeature(feature: String!, version: String!)

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!

getFirstChild()

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

Node!

getLastChild()

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

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.

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.

Node!

getNextSibling()

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

String!

getNodeName()

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

Short

getNodeType()

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

String!

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!

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!

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!

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!

getPreviousSibling()

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

String!

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!

getUserData(key: String!)

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

hasAttributes()

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

Boolean

hasChildNodes()

Returns whether this node has any children.

Node!

insertBefore(newChild: Node!, refChild: 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.

Boolean

isDefaultNamespace(namespaceURI: String!)

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

Boolean

isEqualNode(arg: Node!)

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

isSameNode(other: Node!)

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

isSupported(feature: String!, version: String!)

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

String!

lookupNamespaceURI(prefix: 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.

String!

lookupPrefix(namespaceURI: 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.

Unit

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.

Node!

removeChild(oldChild: Node!)

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

Node!

replaceChild(newChild: Node!, oldChild: 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.

Unit

setNodeValue(nodeValue: 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.

Unit

setPrefix(prefix: String!)

Unit

setTextContent(textContent: String!)

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!

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

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

getName

Added in API level 1

abstract fun getName(): String!

Returns the name of this attribute. If Node.localName is different from null, this attribute is a qualified name.

getOwnerElement

Added in API level 1

abstract fun getOwnerElement(): Element!

The Element node this attribute is attached to or null if this attribute is not in use.

getSchemaTypeInfo

Added in API level 8

abstract fun getSchemaTypeInfo(): TypeInfo!

The type information associated with this attribute. While the type information contained in this attribute is guarantee to be correct after loading the document or invoking Document.normalizeDocument(), schemaTypeInfo may not be reliable if the node was moved.

getSpecified

Added in API level 1

abstract fun getSpecified(): Boolean

True if this attribute was explicitly given a value in the instance document, false otherwise. If the application changed the value of this attribute node (even if it ends up having the same value as the default value) then it is set to true. The implementation may handle attributes with default values from other schemas similarly but applications should use Document.normalizeDocument() to guarantee this information is up-to-date.

getValue

Added in API level 1

abstract fun getValue(): String!

On retrieval, the value of the attribute is returned as a string. Character and general entity references are replaced with their values. See also the method getAttribute on the Element interface.
On setting, this creates a Text node with the unparsed contents of the string, i.e. any characters that an XML processor would recognize as markup are instead treated as literal text. See also the method Element.setAttribute().
Some specialized implementations, such as some [SVG 1.1] implementations, may do normalization automatically, even after mutation; in such case, the value on retrieval may differ from the value on setting.

isId

Added in API level 8

abstract fun isId(): Boolean

Returns whether this attribute is known to be of type ID (i.e. to contain an identifier for its owner element) or not. When it is and its value is unique, the ownerElement of this attribute can be retrieved using the method Document.getElementById . The implementation could use several ways to determine if an attribute node is known to contain an identifier:

If validation occurred using an XML Schema [XML Schema Part 1] while loading the document or while invoking Document.normalizeDocument(), the post-schema-validation infoset contributions (PSVI contributions) values are used to determine if this attribute is a schema-determined ID attribute using the schema-determined ID definition in [XPointer] .
If validation occurred using a DTD while loading the document or while invoking Document.normalizeDocument(), the infoset [type definition] value is used to determine if this attribute is a DTD-determined ID attribute using the DTD-determined ID definition in [XPointer] .
from the use of the methods Element.setIdAttribute(), Element.setIdAttributeNS(), or Element.setIdAttributeNode(), i.e. it is an user-determined ID attribute;
Note: XPointer framework (see section 3.2 in [XPointer] ) consider the DOM user-determined ID attribute as being part of the XPointer externally-determined ID definition.
using mechanisms that are outside the scope of this specification, it is then an externally-determined ID attribute. This includes using schema languages different from XML schema and DTD.

If validation occurred while invoking Document.normalizeDocument(), all user-determined ID attributes are reset and all attribute nodes ID information are then reevaluated in accordance to the schema used. As a consequence, if the Attr.schemaTypeInfo attribute contains an ID type, isId will always return true.

setValue

Added in API level 1

abstract fun setValue(value: String!): Unit

Exceptions
`org.w3c.dom.DOMException`	NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.