Class DomDoctype

public DomDoctype(DomDocument doc,
                  String name,
                  String publicId,
                  String systemId)

JAXP builder constructor.

Parameters:

doc - the document

name - the name of the document element

publicId - the public ID of the document type declaration

systemId - the system ID of the document type declaration

protected DomDoctype(DOMImplementation impl,
                     String name,
                     String publicId,
                     String systemId,
                     String internalSubset)

Constructs a DocumentType node associated with the specified implementation, with the specified name.

This constructor should only be invoked by a DOMImplementation as part of its createDocumentType functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Note that at this time there is no standard SAX API granting access to the internal subset text, so that relying on that value is not currently portable.

Parameters:

impl - The implementation with which this object is associated

name - Name of this root element

publicId - If non-null, provides the external subset's PUBLIC identifier

systemId - If non-null, provides the external subset's SYSTEM identifier

internalSubset - Provides the literal value (unparsed, no entities expanded) of the DTD's internal subset.

public void attributeDecl(String eName,
                          String aName,
                          String type,
                          String mode,
                          String value)

public Object clone()

Shallow clone of the doctype, except that associated entities and notations are (deep) cloned.

Overrides:

clone in interface DomNode

public Entity declareEntity(String name,
                            String publicId,
                            String systemId,
                            String notation)

Records the declaration of a general entity in this DocumentType.

Parameters:

name - Name of the entity

publicId - If non-null, provides the entity's PUBLIC identifier

systemId - Provides the entity's SYSTEM identifier

notation - If non-null, provides the entity's notation (indicating an unparsed entity)

Returns:

The Entity that was declared, or null if the entity wasn't recorded (because it's a parameter entity or because an entity with this name was already declared).

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR if the DocumentType is no longer writable.

DOMException - HIERARCHY_REQUEST_ERR if the DocumentType is not associated with a document.

public Notation declareNotation(String name,
                                String publicId,
                                String systemId)

Records the declaration of a notation in this DocumentType.

Parameters:

name - Name of the notation

publicId - If non-null, provides the notation's PUBLIC identifier

systemId - If non-null, provides the notation's SYSTEM identifier

Returns:

The notation that was declared.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR if the DocumentType is no longer writable.

DOMException - HIERARCHY_REQUEST_ERR if the DocumentType is not associated with a document.

public void elementDecl(String name,
                        String model)

public final String getBaseURI()

The base URI of a DocumentType is always null. See the Infoset Mapping, appendix C.

Specified by:

getBaseURI in interface Node

Overrides:

getBaseURI in interface DomNode

public NamedNodeMap getEntities()

DOM L1 Returns information about any general entities declared in the DTD.

Note: DOM L1 doesn't throw a DOMException here, but then it doesn't have the strange construction rules of L2.

Specified by:

getEntities in interface DocumentType

Throws:

DOMException - HIERARCHY_REQUEST_ERR if the DocumentType is not associated with a document.

public final DOMImplementation getImplementation()

Returns the implementation associated with this document type.

public String getInternalSubset()

DOM L2 Returns the internal subset of the document, as a string of unparsed XML declarations (and comments, PIs, whitespace); or returns null if there is no such subset. There is no vendor-independent expectation that this attribute be set, or that declarations found in it be reflected in the entities or notations attributes of this Document "Type" object.

Some application-specific XML profiles require that documents only use specific PUBLIC identifiers, without an internal subset to modify the interperetation of the declarations associated with that PUBLIC identifier through some standard.

Specified by:

getInternalSubset in interface DocumentType

public final String getName()

DOM L1 Returns the root element's name (just like getNodeName).

Specified by:

getName in interface DocumentType

public NamedNodeMap getNotations()

DOM L1 Returns information about any notations declared in the DTD.

Note: DOM L1 doesn't throw a DOMException here, but then it doesn't have the strange construction rules of L2.

Specified by:

getNotations in interface DocumentType

Throws:

DOMException - HIERARCHY_REQUEST_ERR if the DocumentType is not associated with a document.

public boolean isSameNode(Node arg)

Specified by:

isSameNode in interface Node

Overrides:

isSameNode in interface DomNode

public void makeReadonly()

Sets the internal "readonly" flag so the node and its associated data (only lists of entities and notations, no type information at the moment) can't be changed.

Overrides:

makeReadonly in interface DomNode

public final boolean supports(String feature,
                              String version)

DOM L2 Consults the DOM implementation to determine if the requested feature is supported.