org.dom4j.dom

Class DOMDocumentType

java.lang.Object

org.dom4j.tree.AbstractNode

org.dom4j.tree.AbstractDocumentType

org.dom4j.tree.DefaultDocumentType

org.dom4j.dom.DOMDocumentType

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, DocumentType, Node

public class DOMDocumentType
extends DefaultDocumentType
implements org.w3c.dom.DocumentType

DOMDocumentType implements a DocumentType node which supports the W3C DOM API.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dom4j.tree.DefaultDocumentType

elementName

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
DOMDocumentType()
DOMDocumentType(java.lang.String elementName, java.lang.String systemID)
DOMDocumentType(java.lang.String name, java.lang.String publicID, java.lang.String systemID)

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Node	appendChild(org.w3c.dom.Node newChild)
org.w3c.dom.Node	cloneNode(boolean deep)
short	compareDocumentPosition(org.w3c.dom.Node other)
org.w3c.dom.NamedNodeMap	getAttributes()
java.lang.String	getBaseURI()
org.w3c.dom.NodeList	getChildNodes()
org.w3c.dom.NamedNodeMap	getEntities()
java.lang.Object	getFeature(java.lang.String feature, java.lang.String version)
org.w3c.dom.Node	getFirstChild()
java.lang.String	getInternalSubset()
org.w3c.dom.Node	getLastChild()
java.lang.String	getLocalName()
java.lang.String	getNamespaceURI()
org.w3c.dom.Node	getNextSibling()
java.lang.String	getNodeName()
short	getNodeType() Returns the code according to the type of node.
java.lang.String	getNodeValue()
org.w3c.dom.NamedNodeMap	getNotations()
org.w3c.dom.Document	getOwnerDocument()
org.w3c.dom.Node	getParentNode()
java.lang.String	getPrefix()
org.w3c.dom.Node	getPreviousSibling()
java.lang.String	getPublicId()
java.lang.String	getSystemId()
java.lang.String	getTextContent()
java.lang.Object	getUserData(java.lang.String key)
boolean	hasAttributes()
boolean	hasChildNodes()
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild)
boolean	isDefaultNamespace(java.lang.String namespaceURI)
boolean	isEqualNode(org.w3c.dom.Node other)
boolean	isSameNode(org.w3c.dom.Node other)
boolean	isSupported(java.lang.String feature, java.lang.String version)
java.lang.String	lookupNamespaceURI(java.lang.String prefix)
java.lang.String	lookupPrefix(java.lang.String namespaceURI)
void	normalize()
org.w3c.dom.Node	removeChild(org.w3c.dom.Node oldChild)
org.w3c.dom.Node	replaceChild(org.w3c.dom.Node newChild, org.w3c.dom.Node oldChild)
void	setNodeValue(java.lang.String nodeValue)
void	setPrefix(java.lang.String prefix)
void	setTextContent(java.lang.String textContent)
java.lang.Object	setUserData(java.lang.String key, java.lang.Object data, org.w3c.dom.UserDataHandler handler)
boolean	supports(java.lang.String feature, java.lang.String version)

Methods inherited from class org.dom4j.tree.DefaultDocumentType

getElementName, getExternalDeclarations, getInternalDeclarations, getPublicID, getSystemID, setElementName, setExternalDeclarations, setInternalDeclarations, setPublicID, setSystemID

Methods inherited from class org.dom4j.tree.AbstractDocumentType

accept, asXML, getName, getPath, getText, getUniquePath, setName, toString, write

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, clone, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getDocument, getDocumentFactory, getNodeTypeName, getParent, getPath, getStringValue, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.DocumentType

getName

Methods inherited from interface org.dom4j.Node

asXPathResult, clone, createXPath, detach, getDocument, getNodeTypeName, getParent, getPath, getStringValue, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setParent, setText, supportsParent, valueOf

Constructor Detail

DOMDocumentType

public DOMDocumentType()

DOMDocumentType

public DOMDocumentType(java.lang.String elementName,
                       java.lang.String systemID)

DOMDocumentType

public DOMDocumentType(java.lang.String name,
                       java.lang.String publicID,
                       java.lang.String systemID)

Method Detail

supports

public boolean supports(java.lang.String feature,
                        java.lang.String version)

getNamespaceURI

public java.lang.String getNamespaceURI()

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)
               throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getLocalName

public java.lang.String getLocalName()

getNodeName

public java.lang.String getNodeName()

getNodeValue

public java.lang.String getNodeValue()
                              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

setNodeValue

public void setNodeValue(java.lang.String nodeValue)
                  throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getParentNode

public org.w3c.dom.Node getParentNode()

getChildNodes

public org.w3c.dom.NodeList getChildNodes()

getFirstChild

public org.w3c.dom.Node getFirstChild()

getLastChild

public org.w3c.dom.Node getLastChild()

getPreviousSibling

public org.w3c.dom.Node getPreviousSibling()

getNextSibling

public org.w3c.dom.Node getNextSibling()

getAttributes

public org.w3c.dom.NamedNodeMap getAttributes()

getOwnerDocument

public org.w3c.dom.Document getOwnerDocument()

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
                              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

replaceChild

public org.w3c.dom.Node replaceChild(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node oldChild)
                              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

removeChild

public org.w3c.dom.Node removeChild(org.w3c.dom.Node oldChild)
                             throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

appendChild

public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

hasChildNodes

public boolean hasChildNodes()

cloneNode

public org.w3c.dom.Node cloneNode(boolean deep)

normalize

public void normalize()

isSupported

public boolean isSupported(java.lang.String feature,
                           java.lang.String version)

hasAttributes

public boolean hasAttributes()

getEntities

public org.w3c.dom.NamedNodeMap getEntities()

getNotations

public org.w3c.dom.NamedNodeMap getNotations()

getPublicId

public java.lang.String getPublicId()

getSystemId

public java.lang.String getSystemId()

getInternalSubset

public java.lang.String getInternalSubset()

getBaseURI

public java.lang.String getBaseURI()

compareDocumentPosition

public short compareDocumentPosition(org.w3c.dom.Node other)
                              throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

getTextContent

public java.lang.String getTextContent()
                                throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

setTextContent

public void setTextContent(java.lang.String textContent)
                    throws org.w3c.dom.DOMException

Throws:

org.w3c.dom.DOMException

isSameNode

public boolean isSameNode(org.w3c.dom.Node other)

lookupPrefix

public java.lang.String lookupPrefix(java.lang.String namespaceURI)

isDefaultNamespace

public boolean isDefaultNamespace(java.lang.String namespaceURI)

lookupNamespaceURI

public java.lang.String lookupNamespaceURI(java.lang.String prefix)

isEqualNode

public boolean isEqualNode(org.w3c.dom.Node other)

getFeature

public java.lang.Object getFeature(java.lang.String feature,
                                   java.lang.String version)

setUserData

public java.lang.Object setUserData(java.lang.String key,
                                    java.lang.Object data,
                                    org.w3c.dom.UserDataHandler handler)

getUserData

public java.lang.Object getUserData(java.lang.String key)

getNodeType

public short getNodeType()

Description copied from interface: Node

Returns the code according to the type of node. This makes processing nodes polymorphically much easier as the switch statement can be used instead of multiple if (instanceof) statements.

Specified by:

getNodeType in interface Node

Overrides:

getNodeType in class AbstractDocumentType

Returns:

a W3C DOM complient code for the node type such as ELEMENT_NODE or ATTRIBUTE_NODE