# EntityReference Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary:[Inherited Constants](https://developer.android.com/reference/org/w3c/dom/EntityReference#inhconstants)\|[Inherited Methods](https://developer.android.com/reference/org/w3c/dom/EntityReference#inhmethods) # EntityReference ` public interface EntityReference ` ` implements `[Node](https://developer.android.com/reference/org/w3c/dom/Node)` ` |-----------------------------| | org.w3c.dom.EntityReference |
*** ** * ** *** `EntityReference`nodes may be used to represent an entity reference in the tree. Note that character references and references to predefined entities are considered to be expanded by the HTML or XML processor so that characters are represented by their Unicode equivalent rather than by an entity reference. Moreover, the XML processor may completely expand references to entities while building the`Document`, instead of providing`EntityReference`nodes. If it does provide such nodes, then for an`EntityReference`node that represents a reference to a known entity an`Entity`exists, and the subtree of the`EntityReference`node is a copy of the`Entity`node subtree. However, the latter may not be true when an entity contains an unbound namespace prefix. In such a case, because the namespace prefix resolution depends on where the entity reference is, the descendants of the`EntityReference`node may be bound to different namespace URIs. When an`EntityReference`node represents a reference to an unknown entity, the node has no children and its replacement value, when used by`Attr.value`for example, is empty. As for`Entity`nodes,`EntityReference`nodes and all their descendants are readonly. **Note:** `EntityReference`nodes may cause element content and attribute value normalization problems when, such as in XML 1.0 and XML Schema, the normalization is performed after entity reference are expanded. See also the[Document Object Model (DOM) Level 3 Core Specification](http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407). ## Summary | ### Inherited constants | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | From interface[org.w3c.dom.Node](https://developer.android.com/reference/org/w3c/dom/Node) |---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `short` | [ATTRIBUTE_NODE](https://developer.android.com/reference/org/w3c/dom/Node#ATTRIBUTE_NODE) The node is an`Attr`. | | `short` | [CDATA_SECTION_NODE](https://developer.android.com/reference/org/w3c/dom/Node#CDATA_SECTION_NODE) The node is a`CDATASection`. | | `short` | [COMMENT_NODE](https://developer.android.com/reference/org/w3c/dom/Node#COMMENT_NODE) The node is a`Comment`. | | `short` | [DOCUMENT_FRAGMENT_NODE](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_FRAGMENT_NODE) The node is a`DocumentFragment`. | | `short` | [DOCUMENT_NODE](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_NODE) The node is a`Document`. | | `short` | [DOCUMENT_POSITION_CONTAINED_BY](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_POSITION_CONTAINED_BY) The node is contained by the reference node. | | `short` | [DOCUMENT_POSITION_CONTAINS](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_POSITION_CONTAINS) The node contains the reference node. | | `short` | [DOCUMENT_POSITION_DISCONNECTED](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_POSITION_DISCONNECTED) The two nodes are disconnected. | | `short` | [DOCUMENT_POSITION_FOLLOWING](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_POSITION_FOLLOWING) The node follows the reference node. | | `short` | [DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC) The determination of preceding versus following is implementation-specific. | | `short` | [DOCUMENT_POSITION_PRECEDING](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_POSITION_PRECEDING) The second node precedes the reference node. | | `short` | [DOCUMENT_TYPE_NODE](https://developer.android.com/reference/org/w3c/dom/Node#DOCUMENT_TYPE_NODE) The node is a`DocumentType`. | | `short` | [ELEMENT_NODE](https://developer.android.com/reference/org/w3c/dom/Node#ELEMENT_NODE) The node is an`Element`. | | `short` | [ENTITY_NODE](https://developer.android.com/reference/org/w3c/dom/Node#ENTITY_NODE) The node is an`Entity`. | | `short` | [ENTITY_REFERENCE_NODE](https://developer.android.com/reference/org/w3c/dom/Node#ENTITY_REFERENCE_NODE) The node is an`EntityReference`. | | `short` | [NOTATION_NODE](https://developer.android.com/reference/org/w3c/dom/Node#NOTATION_NODE) The node is a`Notation`. | | `short` | [PROCESSING_INSTRUCTION_NODE](https://developer.android.com/reference/org/w3c/dom/Node#PROCESSING_INSTRUCTION_NODE) The node is a`ProcessingInstruction`. | | `short` | [TEXT_NODE](https://developer.android.com/reference/org/w3c/dom/Node#TEXT_NODE) The node is a`Text`node. | | | ### Inherited methods | |-----------------------|---| | From interface` `[org.w3c.dom.Node](https://developer.android.com/reference/org/w3c/dom/Node)` ` |----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[appendChild](https://developer.android.com/reference/org/w3c/dom/Node#appendChild(org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` newChild) ` Adds the node`newChild`to the end of the list of children of this node. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[cloneNode](https://developer.android.com/reference/org/w3c/dom/Node#cloneNode(boolean))`(boolean deep) ` Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. | | ` abstract short` | ` `[compareDocumentPosition](https://developer.android.com/reference/org/w3c/dom/Node#compareDocumentPosition(org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` other) ` Compares the reference node, i.e. | | ` abstract `[NamedNodeMap](https://developer.android.com/reference/org/w3c/dom/NamedNodeMap) | ` `[getAttributes](https://developer.android.com/reference/org/w3c/dom/Node#getAttributes())`() ` A`NamedNodeMap`containing the attributes of this node (if it is an`Element`) or`null`otherwise. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getBaseURI](https://developer.android.com/reference/org/w3c/dom/Node#getBaseURI())`() ` The absolute base URI of this node or`null`if the implementation wasn't able to obtain an absolute URI. | | ` abstract `[NodeList](https://developer.android.com/reference/org/w3c/dom/NodeList) | ` `[getChildNodes](https://developer.android.com/reference/org/w3c/dom/Node#getChildNodes())`() ` A`NodeList`that contains all children of this node. | | ` abstract `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[getFeature](https://developer.android.com/reference/org/w3c/dom/Node#getFeature(java.lang.String,%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` feature, `[String](https://developer.android.com/reference/java/lang/String)` version) ` This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in . | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[getFirstChild](https://developer.android.com/reference/org/w3c/dom/Node#getFirstChild())`() ` The first child of this node. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[getLastChild](https://developer.android.com/reference/org/w3c/dom/Node#getLastChild())`() ` The last child of this node. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getLocalName](https://developer.android.com/reference/org/w3c/dom/Node#getLocalName())`() ` Returns the local part of the qualified name of this node. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getNamespaceURI](https://developer.android.com/reference/org/w3c/dom/Node#getNamespaceURI())`() ` The namespace URI of this node, or`null`if it is unspecified (see ). | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[getNextSibling](https://developer.android.com/reference/org/w3c/dom/Node#getNextSibling())`() ` The node immediately following this node. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getNodeName](https://developer.android.com/reference/org/w3c/dom/Node#getNodeName())`() ` The name of this node, depending on its type; see the table above. | | ` abstract short` | ` `[getNodeType](https://developer.android.com/reference/org/w3c/dom/Node#getNodeType())`() ` A code representing the type of the underlying object, as defined above. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getNodeValue](https://developer.android.com/reference/org/w3c/dom/Node#getNodeValue())`() ` The value of this node, depending on its type; see the table above. | | ` abstract `[Document](https://developer.android.com/reference/org/w3c/dom/Document) | ` `[getOwnerDocument](https://developer.android.com/reference/org/w3c/dom/Node#getOwnerDocument())`() ` The`Document`object associated with this node. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[getParentNode](https://developer.android.com/reference/org/w3c/dom/Node#getParentNode())`() ` The parent of this node. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getPrefix](https://developer.android.com/reference/org/w3c/dom/Node#getPrefix())`() ` The namespace prefix of this node, or`null`if it is unspecified. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[getPreviousSibling](https://developer.android.com/reference/org/w3c/dom/Node#getPreviousSibling())`() ` The node immediately preceding this node. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[getTextContent](https://developer.android.com/reference/org/w3c/dom/Node#getTextContent())`() ` This attribute returns the text content of this node and its descendants. | | ` abstract `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[getUserData](https://developer.android.com/reference/org/w3c/dom/Node#getUserData(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` key) ` Retrieves the object associated to a key on a this node. | | ` abstract boolean` | ` `[hasAttributes](https://developer.android.com/reference/org/w3c/dom/Node#hasAttributes())`() ` Returns whether this node (if it is an element) has any attributes. | | ` abstract boolean` | ` `[hasChildNodes](https://developer.android.com/reference/org/w3c/dom/Node#hasChildNodes())`() ` Returns whether this node has any children. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[insertBefore](https://developer.android.com/reference/org/w3c/dom/Node#insertBefore(org.w3c.dom.Node,%20org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` newChild, `[Node](https://developer.android.com/reference/org/w3c/dom/Node)` refChild) ` Inserts the node`newChild`before the existing child node`refChild`. | | ` abstract boolean` | ` `[isDefaultNamespace](https://developer.android.com/reference/org/w3c/dom/Node#isDefaultNamespace(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` namespaceURI) ` This method checks if the specified`namespaceURI`is the default namespace or not. | | ` abstract boolean` | ` `[isEqualNode](https://developer.android.com/reference/org/w3c/dom/Node#isEqualNode(org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` arg) ` Tests whether two nodes are equal. | | ` abstract boolean` | ` `[isSameNode](https://developer.android.com/reference/org/w3c/dom/Node#isSameNode(org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` other) ` Returns whether this node is the same node as the given one. | | ` abstract boolean` | ` `[isSupported](https://developer.android.com/reference/org/w3c/dom/Node#isSupported(java.lang.String,%20java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` feature, `[String](https://developer.android.com/reference/java/lang/String)` version) ` Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in . | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[lookupNamespaceURI](https://developer.android.com/reference/org/w3c/dom/Node#lookupNamespaceURI(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` prefix) ` Look up the namespace URI associated to the given prefix, starting from this node. | | ` abstract `[String](https://developer.android.com/reference/java/lang/String) | ` `[lookupPrefix](https://developer.android.com/reference/org/w3c/dom/Node#lookupPrefix(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` namespaceURI) ` Look up the prefix associated to the given namespace URI, starting from this node. | | ` abstract void` | ` `[normalize](https://developer.android.com/reference/org/w3c/dom/Node#normalize())`() ` Puts all`Text`nodes in the full depth of the sub-tree underneath this`Node`, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates`Text`nodes, i.e., there are neither adjacent`Text`nodes nor empty`Text`nodes. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[removeChild](https://developer.android.com/reference/org/w3c/dom/Node#removeChild(org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` oldChild) ` Removes the child node indicated by`oldChild`from the list of children, and returns it. | | ` abstract `[Node](https://developer.android.com/reference/org/w3c/dom/Node) | ` `[replaceChild](https://developer.android.com/reference/org/w3c/dom/Node#replaceChild(org.w3c.dom.Node,%20org.w3c.dom.Node))`(`[Node](https://developer.android.com/reference/org/w3c/dom/Node)` newChild, `[Node](https://developer.android.com/reference/org/w3c/dom/Node)` oldChild) ` Replaces the child node`oldChild`with`newChild`in the list of children, and returns the`oldChild`node. | | ` abstract void` | ` `[setNodeValue](https://developer.android.com/reference/org/w3c/dom/Node#setNodeValue(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` nodeValue) ` The value of this node, depending on its type; see the table above. | | ` abstract void` | ` `[setPrefix](https://developer.android.com/reference/org/w3c/dom/Node#setPrefix(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` prefix) ` The namespace prefix of this node, or`null`if it is unspecified. | | ` abstract void` | ` `[setTextContent](https://developer.android.com/reference/org/w3c/dom/Node#setTextContent(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` textContent) ` This attribute returns the text content of this node and its descendants. | | ` abstract `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[setUserData](https://developer.android.com/reference/org/w3c/dom/Node#setUserData(java.lang.String,%20java.lang.Object,%20org.w3c.dom.UserDataHandler))`(`[String](https://developer.android.com/reference/java/lang/String)` key, `[Object](https://developer.android.com/reference/java/lang/Object)` data, `[UserDataHandler](https://developer.android.com/reference/org/w3c/dom/UserDataHandler)` handler) ` Associate an object to a key on this node. | ||