org.jdom

Class DocType

public class DocType extends Object implements Serializable, Cloneable

DocType represents an XML DOCTYPE declaration.

Version: $Revision: 1.18 $, $Date: 2002/02/05 08:03:18 $

Author: Brett McLaughlin Jason Hunter

Field Summary
protected Documentdocument
The document having this DOCTYPE
protected StringelementName
The element being constrained
protected StringinternalSubset
The internal subset of the DOCTYPE
protected StringpublicID
The public ID of the DOCTYPE
protected StringsystemID
The system ID of the DOCTYPE
Constructor Summary
protected DocType()

Default, no-args constructor for implementations to use if needed.

DocType(String elementName, String publicID, String systemID)

This will create the DocType with the specified element name and a reference to an external DTD.

DocType(String elementName, String systemID)

This will create the DocType with the specified element name and reference to an external DTD.

DocType(String elementName)

This will create the DocType with the specified element name

Method Summary
Objectclone()

This will return a clone of this DocType.

booleanequals(Object ob)

This tests for equality of this DocType to the supplied Object.

DocumentgetDocument()

This retrieves the owning Document for this DocType, or null if not a currently a member of a Document.

StringgetElementName()

This will retrieve the element name being constrained.

StringgetInternalSubset()

This returns the data for the internal subset

StringgetPublicID()

This will retrieve the public ID of an externally referenced DTD, or an empty String if none is referenced.

StringgetSystemID()

This will retrieve the system ID of an externally referenced DTD, or an empty String if none is referenced.

inthashCode()

This returns the hash code for this DocType.

protected DocTypesetDocument(Document document)

This sets the Document holding this doctype.

DocTypesetElementName(String elementName)

This will set the root element name declared by this DOCTYPE declaration.

voidsetInternalSubset(String newData)

This sets the data for the internal subset.

DocTypesetPublicID(String publicID)

This will set the public ID of an externally referenced DTD.

DocTypesetSystemID(String systemID)

This will set the system ID of an externally referenced DTD.

StringtoString()

This returns a String representation of the DocType, suitable for debugging.

Field Detail

document

protected Document document
The document having this DOCTYPE

elementName

protected String elementName
The element being constrained

internalSubset

protected String internalSubset
The internal subset of the DOCTYPE

publicID

protected String publicID
The public ID of the DOCTYPE

systemID

protected String systemID
The system ID of the DOCTYPE

Constructor Detail

DocType

protected DocType()

Default, no-args constructor for implementations to use if needed.

DocType

public DocType(String elementName, String publicID, String systemID)

This will create the DocType with the specified element name and a reference to an external DTD.

Parameters: elementName String name of element being constrained. publicID String public ID of referenced DTD systemID String system ID of referenced DTD

Throws: IllegalDataException if the given system ID is not a legal system literal or the public ID is not a legal public ID. IllegalNameException if the given root element name is not a legal XML element name.

DocType

public DocType(String elementName, String systemID)

This will create the DocType with the specified element name and reference to an external DTD.

Parameters: elementName String name of element being constrained. systemID String system ID of referenced DTD

Throws: IllegalDataException if the given system ID is not a legal system literal. IllegalNameException if the given root element name is not a legal XML element name.

DocType

public DocType(String elementName)

This will create the DocType with the specified element name

Parameters: elementName String name of element being constrained.

Throws: IllegalNameException if the given root element name is not a legal XML element name.

Method Detail

clone

public Object clone()

This will return a clone of this DocType.

Returns: Object - clone of this DocType.

equals

public final boolean equals(Object ob)

This tests for equality of this DocType to the supplied Object.

Parameters: ob Object to compare to.

Returns: boolean - whether the DocType is equal to the supplied Object.

getDocument

public Document getDocument()

This retrieves the owning Document for this DocType, or null if not a currently a member of a Document.

Returns: Document owning this DocType, or null.

getElementName

public String getElementName()

This will retrieve the element name being constrained.

Returns: String - element name for DOCTYPE

getInternalSubset

public String getInternalSubset()

This returns the data for the internal subset

Returns: String - the internal subset

getPublicID

public String getPublicID()

This will retrieve the public ID of an externally referenced DTD, or an empty String if none is referenced.

Returns: String - public ID of referenced DTD.

getSystemID

public String getSystemID()

This will retrieve the system ID of an externally referenced DTD, or an empty String if none is referenced.

Returns: String - system ID of referenced DTD.

hashCode

public final int hashCode()

This returns the hash code for this DocType.

Returns: int - hash code.

setDocument

protected DocType setDocument(Document document)

This sets the Document holding this doctype.

Parameters: DocType Document holding this doctype

Returns: Document this DocType modified

setElementName

public DocType setElementName(String elementName)

This will set the root element name declared by this DOCTYPE declaration.

Parameters: elementName String name of root element being constrained.

Returns: DocType DocType this DocType object

Throws: IllegalNameException if the given root element name is not a legal XML element name.

setInternalSubset

public void setInternalSubset(String newData)

This sets the data for the internal subset.

Parameters: newData data for the internal subset, as a String.

setPublicID

public DocType setPublicID(String publicID)

This will set the public ID of an externally referenced DTD.

Returns: DocType DocType this DocType object

Throws: IllegalDataException if the given public ID is not a legal public ID.

setSystemID

public DocType setSystemID(String systemID)

This will set the system ID of an externally referenced DTD.

Returns: systemID String system ID of referenced DTD.

Throws: IllegalDataException if the given system ID is not a legal system literal.

toString

public String toString()

This returns a String representation of the DocType, suitable for debugging.

Returns: String - information about the DocType

Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.