Class EntityRef

  • EntityRef represents an XML EntityReference node.

  • It provides methods to get and set the name, public ID, and system ID of the node.

  • You can detach an EntityRef node from its parent element.

  • You can get the text value of all child nodes.
EntityRef

A representation of an XML EntityReference node.

Methods

MethodReturn typeBrief description
detach()Content|nullDetaches the node from its parent Element node.
getName()StringGets the name of the EntityReference node.
getParentElement()Element|nullGets the node's parent Element node.
getPublicId()String|nullGets the public ID of the EntityReference node.
getSystemId()String|nullGets the system ID of the EntityReference node.
getValue()StringGets the text value of all nodes that are direct or indirect children of the node, in the order they appear in the document.
setName(name)EntityRefSets the name of the EntityReference node.
setPublicId(id)EntityRefSets the public ID of the EntityReference node.
setSystemId(id)EntityRefSets the system ID of the EntityReference node.

Detailed documentation

detach()

Detaches the node from its parent Element node. If the node does not have a parent, this method has no effect.

Return

Content|null — The detached node.

getName()

Gets the name of the EntityReference node.

Return

String — The name of the EntityReference node.

getParentElement()

Gets the node's parent Element node. If the node does not have a parent, this method returns null.

Return

Element|null — The parent Element node.

getPublicId()

Gets the public ID of the EntityReference node. If the node does not have a public ID, this method returns null.

Return

String|null — The public ID of the EntityReference node, or null if it has none.

getSystemId()

Gets the system ID of the EntityReference node. If the node does not have a system ID, this method returns null.

Return

String|null — The system ID of the EntityReference node, or null if it has none.

getValue()

Gets the text value of all nodes that are direct or indirect children of the node, in the order they appear in the document.

Return

String — The text value of all nodes that are direct or indirect children of the node.

setName(name)

Sets the name of the EntityReference node.

Parameters

NameTypeDescription
nameStringThe name to set.

Return

EntityRef — The EntityReference node, for chaining.

setPublicId(id)

Sets the public ID of the EntityReference node.

Parameters

NameTypeDescription
idStringThe public ID to set.

Return

EntityRef — The EntityReference node, for chaining.

setSystemId(id)

Sets the system ID of the EntityReference node.

Parameters

NameTypeDescription
idStringThe system ID to set.

Return

EntityRef — The EntityReference node, for chaining.