Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

DocType Class Reference

List of all members.

Public Methods

 DocType (String elementName, String publicID, String systemID)
 DocType (String elementName, String systemID)
 DocType (String elementName)
String getElementName ()
DocType setElementName (String elementName)
String getPublicID ()
DocType setPublicID (String publicID)
String getSystemID ()
DocType setSystemID (String systemID)
Document getDocument ()
void setInternalSubset (String newData)
String getInternalSubset ()
String toString ()
final boolean equals (Object ob)
final int hashCode ()
Object clone ()

Protected Methods

 DocType ()
DocType setDocument (Document document)

Protected Attributes

String elementName
String publicID
String systemID
Document document
String internalSubset

Detailed Description

DocType represents an XML DOCTYPE declaration.

Author:
Brett McLaughlin , Jason Hunter
Version:
Revision:
1.18
,
Date:
2002/02/05 08:03:18


Constructor & Destructor Documentation

DocType::DocType   [inline, protected]
 

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

DocType::DocType String    elementName,
String    publicID,
String    systemID
[inline]
 

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
Exceptions:
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::DocType String    elementName,
String    systemID
[inline]
 

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
Exceptions:
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::DocType String    elementName [inline]
 

This will create the DocType with the specified element name

Parameters:
elementName  String name of element being constrained.
Exceptions:
IllegalNameException  if the given root element name is not a legal XML element name.


Member Function Documentation

Object DocType::clone   [inline]
 

This will return a clone of this DocType.

Returns:
Object - clone of this DocType.

final boolean DocType::equals Object    ob [inline]
 

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.

Document DocType::getDocument   [inline]
 

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.

String DocType::getElementName   [inline]
 

This will retrieve the element name being constrained.

Returns:
String - element name for DOCTYPE

String DocType::getInternalSubset   [inline]
 

This returns the data for the internal subset

Returns:
String - the internal subset

String DocType::getPublicID   [inline]
 

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.

String DocType::getSystemID   [inline]
 

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.

final int DocType::hashCode   [inline]
 

This returns the hash code for this DocType.

Returns:
int - hash code.

DocType DocType::setDocument Document    document [inline, protected]
 

This sets the Document holding this doctype.

Parameters:
DocType  Document holding this doctype
Returns:
Document this DocType modified

DocType DocType::setElementName String    elementName [inline]
 

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

Returns:
DocType DocType this DocType object
Parameters:
elementName  String name of root element being constrained.
Exceptions:
IllegalNameException  if the given root element name is not a legal XML element name.

void DocType::setInternalSubset String    newData [inline]
 

This sets the data for the internal subset.

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

DocType DocType::setPublicID String    publicID [inline]
 

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

Returns:
DocType DocType this DocType object
Exceptions:
IllegalDataException  if the given public ID is not a legal public ID.

DocType DocType::setSystemID String    systemID [inline]
 

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

Returns:
systemID String system ID of referenced DTD.
Exceptions:
IllegalDataException  if the given system ID is not a legal system literal.

String DocType::toString   [inline]
 

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

Returns:
String - information about the DocType


Member Data Documentation

Document DocType::document [protected]
 

The document having this DOCTYPE

String DocType::elementName [protected]
 

The element being constrained

String DocType::internalSubset [protected]
 

The internal subset of the DOCTYPE

String DocType::publicID [protected]
 

The public ID of the DOCTYPE

String DocType::systemID [protected]
 

The system ID of the DOCTYPE


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:03 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001