org.dom4j.dom

Class DOMEntityReference

java.lang.Object

org.dom4j.tree.AbstractNode

org.dom4j.tree.AbstractEntity

org.dom4j.tree.FlyweightEntity

org.dom4j.tree.DefaultEntity

org.dom4j.dom.DOMEntityReference

All Implemented Interfaces:

Serializable, Cloneable, Entity, Node, EntityReference

public class DOMEntityReference
extends DefaultEntity
implements EntityReference

DOMEntity implements a Entity node which supports the W3C DOM API.

Version:

$Revision: 1.12 $

Author:

James Strachan

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dom4j.tree.FlyweightEntity

name, text

Fields inherited from class org.dom4j.tree.AbstractNode

NODE_TYPE_NAMES

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

Fields inherited from interface org.dom4j.Node

ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

Constructor Summary

Constructors

Constructor and Description
DOMEntityReference(Element parent, String name, String text)
DOMEntityReference(String name)
DOMEntityReference(String name, String text)

Method Summary

Modifier and Type	Method and Description
Node	appendChild(Node newChild)
Node	cloneNode(boolean deep)
short	compareDocumentPosition(Node other)
NamedNodeMap	getAttributes()
String	getBaseURI()
NodeList	getChildNodes()
Object	getFeature(String feature, String version)
Node	getFirstChild()
Node	getLastChild()
String	getLocalName()
String	getNamespaceURI()
Node	getNextSibling()
String	getNodeName()
String	getNodeValue()
Document	getOwnerDocument()
Node	getParentNode()
String	getPrefix()
Node	getPreviousSibling()
String	getTextContent()
Object	getUserData(String key)
boolean	hasAttributes()
boolean	hasChildNodes()
Node	insertBefore(Node newChild, Node refChild)
boolean	isDefaultNamespace(String namespaceURI)
boolean	isEqualNode(Node other)
boolean	isSameNode(Node other)
boolean	isSupported(String feature, String version)
String	lookupNamespaceURI(String prefix)
String	lookupPrefix(String namespaceURI)
void	normalize()
Node	removeChild(Node oldChild)
Node	replaceChild(Node newChild, Node oldChild)
void	setNodeValue(String nodeValue)
void	setPrefix(String prefix)
void	setTextContent(String textContent)
Object	setUserData(String key, Object data, UserDataHandler handler)
boolean	supports(String feature, String version)

Methods inherited from class org.dom4j.tree.DefaultEntity

getParent, isReadOnly, setName, setParent, setText, supportsParent

Methods inherited from class org.dom4j.tree.FlyweightEntity

createXPathResult, getName, getText

Methods inherited from class org.dom4j.tree.AbstractEntity

accept, asXML, getNodeType, getPath, getStringValue, getUniquePath, toString, write

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, clone, createPattern, createXPath, createXPathFilter, detach, getDocument, getDocumentFactory, getNodeTypeName, getPath, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

getNodeType

Methods inherited from interface org.dom4j.Node

asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getPath, getUniquePath, hasContent, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, valueOf

Constructor Detail

DOMEntityReference

public DOMEntityReference(String name)

DOMEntityReference

public DOMEntityReference(String name,
                          String text)

DOMEntityReference

public DOMEntityReference(Element parent,
                          String name,
                          String text)

Method Detail

supports

public boolean supports(String feature,
                        String version)

getNamespaceURI

public String getNamespaceURI()

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)
               throws DOMException

Throws:

DOMException

getLocalName

public String getLocalName()

getNodeName

public String getNodeName()

getNodeValue

public String getNodeValue()
                    throws DOMException

Throws:

DOMException

setNodeValue

public void setNodeValue(String nodeValue)
                  throws DOMException

Throws:

DOMException

getParentNode

public Node getParentNode()

getChildNodes

public NodeList getChildNodes()

getFirstChild

public Node getFirstChild()

getLastChild

public Node getLastChild()

getPreviousSibling

public Node getPreviousSibling()

getNextSibling

public Node getNextSibling()

getAttributes

public NamedNodeMap getAttributes()

getOwnerDocument

public Document getOwnerDocument()

insertBefore

public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException

Throws:

DOMException

replaceChild

public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException

Throws:

DOMException

removeChild

public Node removeChild(Node oldChild)
                 throws DOMException

Throws:

DOMException

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Throws:

DOMException

hasChildNodes

public boolean hasChildNodes()

cloneNode

public Node cloneNode(boolean deep)

normalize

public void normalize()

isSupported

public boolean isSupported(String feature,
                           String version)

hasAttributes

public boolean hasAttributes()

getBaseURI

public String getBaseURI()

compareDocumentPosition

public short compareDocumentPosition(Node other)
                              throws DOMException

Throws:

DOMException

getTextContent

public String getTextContent()
                      throws DOMException

Throws:

DOMException

setTextContent

public void setTextContent(String textContent)
                    throws DOMException

Throws:

DOMException

isSameNode

public boolean isSameNode(Node other)

lookupPrefix

public String lookupPrefix(String namespaceURI)

isDefaultNamespace

public boolean isDefaultNamespace(String namespaceURI)

lookupNamespaceURI

public String lookupNamespaceURI(String prefix)

isEqualNode

public boolean isEqualNode(Node other)

getFeature

public Object getFeature(String feature,
                         String version)

setUserData

public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)

getUserData

public Object getUserData(String key)