DocumentType

public interface DocumentType
implements Node

org.w3c.dom.DocumentType


Each Document has a doctype attribute whose value is either null or a DocumentType object. The DocumentType interface in the DOM Core provides an interface to the list of entities that are defined for the document, and little else because the effect of namespaces and the various XML schema efforts on DTD representation are not clearly understood as of this writing.

DOM Level 3 doesn't support editing DocumentType nodes. DocumentType nodes are read-only.

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

Summary

Inherited constants

short ATTRIBUTE_NODE

The node is an Attr.

short CDATA_SECTION_NODE

The node is a CDATASection.

short COMMENT_NODE

The node is a Comment.

short DOCUMENT_FRAGMENT_NODE

The node is a DocumentFragment.

short DOCUMENT_NODE

The node is a Document.

short DOCUMENT_POSITION_CONTAINED_BY

The node is contained by the reference node.

short DOCUMENT_POSITION_CONTAINS

The node contains the reference node.

short DOCUMENT_POSITION_DISCONNECTED

The two nodes are disconnected.

short DOCUMENT_POSITION_FOLLOWING

The node follows the reference node.

short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

The determination of preceding versus following is implementation-specific.

short DOCUMENT_POSITION_PRECEDING

The second node precedes the reference node.

short DOCUMENT_TYPE_NODE

The node is a DocumentType.

short ELEMENT_NODE

The node is an Element.

short ENTITY_NODE

The node is an Entity.

short ENTITY_REFERENCE_NODE

The node is an EntityReference.

short NOTATION_NODE

The node is a Notation.

short PROCESSING_INSTRUCTION_NODE

The node is a ProcessingInstruction.

short TEXT_NODE

The node is a Text node.

Public methods

abstract NamedNodeMap getEntities()

A NamedNodeMap containing the general entities, both external and internal, declared in the DTD.

abstract String getInternalSubset()

The internal subset as a string, or null if there is none.

abstract String getName()

The name of DTD; i.e., the name immediately following the DOCTYPE keyword.

abstract NamedNodeMap getNotations()

A NamedNodeMap containing the notations declared in the DTD.

abstract String getPublicId()

The public identifier of the external subset.

abstract String getSystemId()

The system identifier of the external subset.

Inherited methods

abstract Node appendChild(Node newChild)

Adds the node newChild to the end of the list of children of this node.

abstract Node cloneNode(boolean deep)

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

abstract short compareDocumentPosition(Node other)

Compares the reference node, i.e.

abstract NamedNodeMap getAttributes()

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

abstract String getBaseURI()

The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.

abstract NodeList getChildNodes()

A NodeList that contains all children of this node.

abstract Object getFeature(String feature, String version)

This method returns a specialized object which implements the specialized APIs of the specified feature and version, as specified in .

abstract Node getFirstChild()

The first child of this node.

abstract Node getLastChild()

The last child of this node.

abstract String getLocalName()

Returns the local part of the qualified name of this node.

abstract String getNamespaceURI()

The namespace URI of this node, or null if it is unspecified (see ).

abstract Node getNextSibling()

The node immediately following this node.

abstract String getNodeName()

The name of this node, depending on its type; see the table above.

abstract short getNodeType()

A code representing the type of the underlying object, as defined above.

abstract String getNodeValue()

The value of this node, depending on its type; see the table above.

abstract Document getOwnerDocument()

The Document object associated with this node.

abstract Node getParentNode()

The parent of this node.

abstract String getPrefix()

The namespace prefix of this node, or null if it is unspecified.

abstract Node getPreviousSibling()

The node immediately preceding this node.

abstract String getTextContent()

This attribute returns the text content of this node and its descendants.

abstract Object getUserData(String key)

Retrieves the object associated to a key on a this node.

abstract boolean hasAttributes()

Returns whether this node (if it is an element) has any attributes.

abstract boolean hasChildNodes()

Returns whether this node has any children.

abstract Node insertBefore(Node newChild, Node refChild)

Inserts the node newChild before the existing child node refChild.

abstract boolean isDefaultNamespace(String namespaceURI)

This method checks if the specified namespaceURI is the default namespace or not.

abstract boolean isEqualNode(Node arg)

Tests whether two nodes are equal.

abstract boolean isSameNode(Node other)

Returns whether this node is the same node as the given one.

abstract boolean isSupported(String feature, String version)

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node, as specified in .

abstract String lookupNamespaceURI(String prefix)

Look up the namespace URI associated to the given prefix, starting from this node.

abstract String lookupPrefix(String namespaceURI)

Look up the prefix associated to the given namespace URI, starting from this node.

abstract void normalize()

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

abstract Node removeChild(Node oldChild)

Removes the child node indicated by oldChild from the list of children, and returns it.

abstract Node replaceChild(Node newChild, Node oldChild)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

abstract void setNodeValue(String nodeValue)

The value of this node, depending on its type; see the table above.

abstract void setPrefix(String prefix)

The namespace prefix of this node, or null if it is unspecified.

abstract void setTextContent(String textContent)

This attribute returns the text content of this node and its descendants.

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

Associate an object to a key on this node.

Public methods

getEntities

Added in API level 1
public abstract NamedNodeMap getEntities ()

A NamedNodeMap containing the general entities, both external and internal, declared in the DTD. Parameter entities are not contained. Duplicates are discarded. For example in:

<!DOCTYPE
 ex SYSTEM "ex.dtd" [ <!ENTITY foo "foo"> <!ENTITY bar
 "bar"> <!ENTITY bar "bar2"> <!ENTITY % baz "baz">
 ]> <ex/>
the interface provides access to foo and the first declaration of bar but not the second declaration of bar or baz. Every node in this map also implements the Entity interface.
The DOM Level 2 does not support editing entities, therefore entities cannot be altered in any way.

Returns
NamedNodeMap

getInternalSubset

Added in API level 1
public abstract String getInternalSubset ()

The internal subset as a string, or null if there is none. This is does not contain the delimiting square brackets.

Note: The actual content returned depends on how much information is available to the implementation. This may vary depending on various parameters, including the XML processor used to build the document.

Returns
String

getName

Added in API level 1
public abstract String getName ()

The name of DTD; i.e., the name immediately following the DOCTYPE keyword.

Returns
String

getNotations

Added in API level 1
public abstract NamedNodeMap getNotations ()

A NamedNodeMap containing the notations declared in the DTD. Duplicates are discarded. Every node in this map also implements the Notation interface.
The DOM Level 2 does not support editing notations, therefore notations cannot be altered in any way.

Returns
NamedNodeMap

getPublicId

Added in API level 1
public abstract String getPublicId ()

The public identifier of the external subset.

Returns
String

getSystemId

Added in API level 1
public abstract String getSystemId ()

The system identifier of the external subset. This may be an absolute URI or not.

Returns
String