org.dom4j
Interface DocumentType

All Superinterfaces:

Cloneable, Node

public interface DocumentType
extends Node

DocumentType defines an XML DOCTYPE declaration.

Version:

$Revision: 1.2 $

Author:

James Strachan

Field Summary

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

Method Summary

DocumentType	clone() clone will return a deep clone or if this node is read-only then clone will return the same instance.
String	getElementName() This method is the equivalent to the Node.getName()method.
List<Object>	getExternalDeclarations() Returns a list of external DTD declaration objects, defined in the org.dom4j.dtdpackage
List<Object>	getInternalDeclarations() Returns a list of internal DTD declaration objects, defined in the org.dom4j.dtd package
String	getPublicID()
String	getSystemID()
void	setElementName(String elementName) This method is the equivalent to the Node.setName(java.lang.String)method.
void	setExternalDeclarations(List<Object> declarations) Sets the list of external DTD declaration objects, defined in the org.dom4j.dtdpackage.
void	setInternalDeclarations(List<Object> declarations) Sets the list of internal DTD declaration objects, defined in the org.dom4j.dtd package.
void	setPublicID(String publicID)
void	setSystemID(String systemID)

Methods inherited from interface org.dom4j.Node

accept, asXML, asXPathResult, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getPath, getStringValue, getText, getUniquePath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write

Method Detail

getElementName

String getElementName()

This method is the equivalent to the Node.getName()method. It is added for clarity.

Returns:

the root element name for the document type.

setElementName

void setElementName(String elementName)

This method is the equivalent to the Node.setName(java.lang.String)method. It is added for clarity.

Parameters:

elementName - the new element name

getPublicID

String getPublicID()

setPublicID

void setPublicID(String publicID)

getSystemID

String getSystemID()

setSystemID

void setSystemID(String systemID)

getInternalDeclarations

List<Object> getInternalDeclarations()

Returns a list of internal DTD declaration objects, defined in the org.dom4j.dtd package

Returns:

internal DTD declarations

setInternalDeclarations

void setInternalDeclarations(List<Object> declarations)

Sets the list of internal DTD declaration objects, defined in the org.dom4j.dtd package. The list is not copied, and existing internal declarations are replaced.

Parameters:

declarations - the declarations to set, replacing existing ones

getExternalDeclarations

List<Object> getExternalDeclarations()

Returns a list of external DTD declaration objects, defined in the org.dom4j.dtdpackage

Returns:

external DTD declarations

setExternalDeclarations

void setExternalDeclarations(List<Object> declarations)

Sets the list of external DTD declaration objects, defined in the org.dom4j.dtdpackage. The list is not copied, and existing external declarations are replaced.

Parameters:

declarations - the declarations to set, replacing existing ones

clone

DocumentType clone()

Description copied from interface: Node

clone will return a deep clone or if this node is read-only then clone will return the same instance.

Specified by:

clone in interface Node

Returns:

a deep clone of myself or myself if I am read only.