Skip to content

Most visited

Recently visited

navigation

Entity

public interface Entity
implements Node

org.w3c.dom.Entity


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 nodeName attribute that is inherited from Node contains 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 EntityReference nodes 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 Entity node's child list represents the structure of that replacement value. Otherwise, the child list is empty.

DOM Level 3 does not support editing Entity nodes; if a user wants to make changes to the contents of an Entity, every related EntityReference node has to be replaced in the structure model by a clone of the Entity's contents, and then the desired changes must be made to each of those clones instead. Entity nodes and all their descendants are readonly.

An Entity node does not have any parent.

Note: If the entity contains an unbound namespace prefix, the namespaceURI of the corresponding node in the Entity node subtree is null. The same is true for EntityReference nodes that refer to this entity, when they are created using the createEntityReference method of the Document interface.

See also the Document Object Model (DOM) Level 3 Core Specification.

Summary

Inherited constants

From interface org.w3c.dom.Node

Public methods

abstract String getInputEncoding()

An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity.

abstract String getNotationName()

For unparsed entities, the name of the notation for the entity.

abstract String getPublicId()

The public identifier associated with the entity if specified, and null otherwise.

abstract String getSystemId()

The system identifier associated with the entity if specified, and null otherwise.

abstract String getXmlEncoding()

An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity.

abstract String getXmlVersion()

An attribute specifying, as part of the text declaration, the version number of this entity, when it is an external parsed entity.

Inherited methods

From interface org.w3c.dom.Node

Public methods

getInputEncoding

Added in API level 8
String getInputEncoding ()

An attribute specifying the encoding used for this entity at the time of parsing, when it is an external parsed entity. This is null if it an entity from the internal subset or if it is not known.

Returns
String

getNotationName

Added in API level 1
String getNotationName ()

For unparsed entities, the name of the notation for the entity. For parsed entities, this is null.

Returns
String

getPublicId

Added in API level 1
String getPublicId ()

The public identifier associated with the entity if specified, and null otherwise.

Returns
String

getSystemId

Added in API level 1
String getSystemId ()

The system identifier associated with the entity if specified, and null otherwise. This may be an absolute URI or not.

Returns
String

getXmlEncoding

Added in API level 8
String getXmlEncoding ()

An attribute specifying, as part of the text declaration, the encoding of this entity, when it is an external parsed entity. This is null otherwise.

Returns
String

getXmlVersion

Added in API level 8
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 is null otherwise.

Returns
String
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.