DOMDocumentType (dom4j API)

java.lang.Object
- org.dom4j.tree.AbstractNode
- - org.dom4j.tree.AbstractDocumentType
  - - org.dom4j.tree.DefaultDocumentType
    - - org.dom4j.dom.DOMDocumentType

All Implemented Interfaces:

Serializable, Cloneable, DocumentType, Node, DocumentType, Node
```
public class DOMDocumentType
extends DefaultDocumentType
implements 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.AbstractNode
  NODE_TYPE_NAMES
- Fields inherited from class org.dom4j.tree.DefaultDocumentType
  elementName
- 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
- 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

Constructor Summary

Constructors
Constructor	Description
`DOMDocumentType()`
`DOMDocumentType(String elementName, String systemID)`
`DOMDocumentType(String name, String publicID, String systemID)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Node`	`appendChild(Node newChild)`
`Node`	`cloneNode(boolean deep)`
`short`	`compareDocumentPosition(Node other)`
`NamedNodeMap`	`getAttributes()`
`String`	`getBaseURI()`
`NodeList`	`getChildNodes()`
`NamedNodeMap`	`getEntities()`
`Object`	`getFeature(String feature, String version)`
`Node`	`getFirstChild()`
`String`	`getInternalSubset()`
`Node`	`getLastChild()`
`String`	`getLocalName()`
`String`	`getNamespaceURI()`
`Node`	`getNextSibling()`
`String`	`getNodeName()`
`short`	`getNodeType()`	Returns the code according to the type of node.
`String`	`getNodeValue()`
`NamedNodeMap`	`getNotations()`
`Document`	`getOwnerDocument()`
`Node`	`getParentNode()`
`String`	`getPrefix()`
`Node`	`getPreviousSibling()`
`String`	`getPublicId()`
`String`	`getSystemId()`
`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.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 org.dom4j.tree.DefaultDocumentType
getElementName, getExternalDeclarations, getInternalDeclarations, getPublicID, getSystemID, setElementName, setExternalDeclarations, setInternalDeclarations, setPublicID, setSystemID

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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DOMDocumentType
```
public DOMDocumentType()
```

DOMDocumentType

public DOMDocumentType(String elementName,
                       String systemID)

DOMDocumentType

public DOMDocumentType(String name,
                       String publicID,
                       String systemID)

Method Detail
- supports
```
public boolean supports(String feature,
                        String version)
```
- getNamespaceURI
```
public String getNamespaceURI()
```
  Specified by:
  
  getNamespaceURI in interface Node
- getPrefix
```
public String getPrefix()
```
  Specified by:
  
  getPrefix in interface Node
- setPrefix
```
public void setPrefix(String prefix)
               throws DOMException
```
  Specified by:
  
  setPrefix in interface Node
  
  Throws:
  
  DOMException
- getLocalName
```
public String getLocalName()
```
  Specified by:
  
  getLocalName in interface Node
- getNodeName
```
public String getNodeName()
```
  Specified by:
  
  getNodeName in interface Node
- getNodeValue
```
public String getNodeValue()
                    throws DOMException
```
  Specified by:
  
  getNodeValue in interface Node
  
  Throws:
  
  DOMException
- setNodeValue
```
public void setNodeValue(String nodeValue)
                  throws DOMException
```
  Specified by:
  
  setNodeValue in interface Node
  
  Throws:
  
  DOMException
- getParentNode
```
public Node getParentNode()
```
  Specified by:
  
  getParentNode in interface Node
- getChildNodes
```
public NodeList getChildNodes()
```
  Specified by:
  
  getChildNodes in interface Node
- getFirstChild
```
public Node getFirstChild()
```
  Specified by:
  
  getFirstChild in interface Node
- getLastChild
```
public Node getLastChild()
```
  Specified by:
  
  getLastChild in interface Node
- getPreviousSibling
```
public Node getPreviousSibling()
```
  Specified by:
  
  getPreviousSibling in interface Node
- getNextSibling
```
public Node getNextSibling()
```
  Specified by:
  
  getNextSibling in interface Node
- getAttributes
```
public NamedNodeMap getAttributes()
```
  Specified by:
  
  getAttributes in interface Node
- getOwnerDocument
```
public Document getOwnerDocument()
```
  Specified by:
  
  getOwnerDocument in interface Node
- insertBefore
```
public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException
```
  Specified by:
  
  insertBefore in interface Node
  
  Throws:
  
  DOMException
- replaceChild
```
public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException
```
  Specified by:
  
  replaceChild in interface Node
  
  Throws:
  
  DOMException
- removeChild
```
public Node removeChild(Node oldChild)
                 throws DOMException
```
  Specified by:
  
  removeChild in interface Node
  
  Throws:
  
  DOMException
- appendChild
```
public Node appendChild(Node newChild)
                 throws DOMException
```
  Specified by:
  
  appendChild in interface Node
  
  Throws:
  
  DOMException
- hasChildNodes
```
public boolean hasChildNodes()
```
  Specified by:
  
  hasChildNodes in interface Node
- cloneNode
```
public Node cloneNode(boolean deep)
```
  Specified by:
  
  cloneNode in interface Node
- normalize
```
public void normalize()
```
  Specified by:
  
  normalize in interface Node
- isSupported
```
public boolean isSupported(String feature,
                           String version)
```
  Specified by:
  
  isSupported in interface Node
- hasAttributes
```
public boolean hasAttributes()
```
  Specified by:
  
  hasAttributes in interface Node
- getEntities
```
public NamedNodeMap getEntities()
```
  Specified by:
  
  getEntities in interface DocumentType
- getNotations
```
public NamedNodeMap getNotations()
```
  Specified by:
  
  getNotations in interface DocumentType
- getPublicId
```
public String getPublicId()
```
  Specified by:
  
  getPublicId in interface DocumentType
- getSystemId
```
public String getSystemId()
```
  Specified by:
  
  getSystemId in interface DocumentType
- getInternalSubset
```
public String getInternalSubset()
```
  Specified by:
  
  getInternalSubset in interface DocumentType
- getBaseURI
```
public String getBaseURI()
```
  Specified by:
  
  getBaseURI in interface Node
- compareDocumentPosition
```
public short compareDocumentPosition(Node other)
                              throws DOMException
```
  Specified by:
  
  compareDocumentPosition in interface Node
  
  Throws:
  
  DOMException
- getTextContent
```
public String getTextContent()
                      throws DOMException
```
  Specified by:
  
  getTextContent in interface Node
  
  Throws:
  
  DOMException
- setTextContent
```
public void setTextContent(String textContent)
                    throws DOMException
```
  Specified by:
  
  setTextContent in interface Node
  
  Throws:
  
  DOMException
- isSameNode
```
public boolean isSameNode(Node other)
```
  Specified by:
  
  isSameNode in interface Node
- lookupPrefix
```
public String lookupPrefix(String namespaceURI)
```
  Specified by:
  
  lookupPrefix in interface Node
- isDefaultNamespace
```
public boolean isDefaultNamespace(String namespaceURI)
```
  Specified by:
  
  isDefaultNamespace in interface Node
- lookupNamespaceURI
```
public String lookupNamespaceURI(String prefix)
```
  Specified by:
  
  lookupNamespaceURI in interface Node
- isEqualNode
```
public boolean isEqualNode(Node other)
```
  Specified by:
  
  isEqualNode in interface Node
- getFeature
```
public Object getFeature(String feature,
                         String version)
```
  Specified by:
  
  getFeature in interface Node
- setUserData
```
public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)
```
  Specified by:
  
  setUserData in interface Node
- getUserData
```
public Object getUserData(String key)
```
  Specified by:
  
  getUserData in interface Node
- 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
  
  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

Class DOMDocumentType

Field Summary

Fields inherited from class org.dom4j.tree.AbstractNode

Fields inherited from class org.dom4j.tree.DefaultDocumentType

Fields inherited from interface org.dom4j.Node

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.dom4j.tree.AbstractDocumentType

Methods inherited from class org.dom4j.tree.AbstractNode

Methods inherited from class org.dom4j.tree.DefaultDocumentType

Methods inherited from interface org.w3c.dom.DocumentType

Methods inherited from interface org.dom4j.Node

Methods inherited from class java.lang.Object

Constructor Detail

DOMDocumentType

DOMDocumentType

DOMDocumentType

Method Detail

supports

getNamespaceURI

getPrefix

setPrefix

getLocalName

getNodeName

getNodeValue

setNodeValue

getParentNode

getChildNodes

getFirstChild

getLastChild

getPreviousSibling

getNextSibling

getAttributes

getOwnerDocument

insertBefore

replaceChild

removeChild

appendChild

hasChildNodes

cloneNode

normalize

isSupported

hasAttributes

getEntities

getNotations

getPublicId

getSystemId

getInternalSubset

getBaseURI

compareDocumentPosition

getTextContent

setTextContent

isSameNode

lookupPrefix

isDefaultNamespace

lookupNamespaceURI

isEqualNode

getFeature

setUserData

getUserData

getNodeType