public interface

DocumentType

implements Node
org.w3c.dom.DocumentType

Class Overview

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.

The DOM Level 2 doesn't support editing DocumentType nodes.

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

Summary

[Expand]
Inherited Constants
From interface org.w3c.dom.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.
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.
[Expand]
Inherited Methods
From interface org.w3c.dom.Node

Public Methods

public abstract NamedNodeMap getEntities ()

Since: API Level 1

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
  • the entities declared in this DTD.

public abstract String getInternalSubset ()

Since: API Level 1

The internal subset as a string. 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
  • the internal subset.

public abstract String getName ()

Since: API Level 1

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

Returns
  • the name of the DTD.

public abstract NamedNodeMap getNotations ()

Since: API Level 1

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
  • the notations declared in this DTD.

public abstract String getPublicId ()

Since: API Level 1

The public identifier of the external subset.

Returns
  • the public identifier.

public abstract String getSystemId ()

Since: API Level 1

The system identifier of the external subset.

Returns
  • the system identifier.