Interface Entity
-
- All Superinterfaces:
- Node
public interface Entity extends Node
This interface represents a known entity, either parsed or unparsed, in an XML document. Note that this models the entity itself not the entity declaration.The
nodeNameattribute that is inherited fromNodecontains the name of the entity.An XML processor may choose to completely expand entities before the structure model is passed to the DOM; in this case there will be no
EntityReferencenodes in the document tree.XML does not mandate that a non-validating XML processor read and process entity declarations made in the external subset or declared in parameter entities. This means that parsed entities declared in the external subset need not be expanded by some classes of applications, and that the replacement text of the entity may not be available. When the replacement text is available, the corresponding
Entitynode's child list represents the structure of that replacement value. Otherwise, the child list is empty.DOM Level 3 does not support editing
Entitynodes; if a user wants to make changes to the contents of anEntity, every relatedEntityReferencenode has to be replaced in the structure model by a clone of theEntity's contents, and then the desired changes must be made to each of those clones instead.Entitynodes and all their descendants are readonly.An
Entitynode does not have any parent.Note: If the entity contains an unbound namespace prefix, the
namespaceURIof the corresponding node in theEntitynode subtree isnull. The same is true forEntityReferencenodes that refer to this entity, when they are created using thecreateEntityReferencemethod of theDocumentinterface.See also the Document Object Model (DOM) Level 3 Core Specification.
-
-
Field Summary
-
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description StringgetInputEncoding()An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity.StringgetNotationName()For unparsed entities, the name of the notation for the entity.StringgetPublicId()The public identifier associated with the entity if specified, andnullotherwise.StringgetSystemId()The system identifier associated with the entity if specified, andnullotherwise.StringgetXmlEncoding()An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.StringgetXmlVersion()An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.-
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
-
-
-
Method Detail
getPublicId
String getPublicId()
The public identifier associated with the entity if specified, andnullotherwise.
getSystemId
String getSystemId()
The system identifier associated with the entity if specified, andnullotherwise. This may be an absolute URI or not.
getNotationName
String getNotationName()
For unparsed entities, the name of the notation for the entity. For parsed entities, this isnull.
getInputEncoding
String getInputEncoding()
An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity. This isnullif it an entity from the internal subset or if it is not known.- Since:
- DOM Level 3
getXmlEncoding
String getXmlEncoding()
An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. This isnullotherwise.- Since:
- DOM Level 3
getXmlVersion
String getXmlVersion()
An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity. This isnullotherwise.- Since:
- DOM Level 3
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
