Main Page | Class Hierarchy | Class List | Class Members

org::jdom::DocType Class Reference

Inheritance diagram for org::jdom::DocType:

org::jdom::Content List of all members.

Public Member Functions

 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)
String getValue ()
void setInternalSubset (String newData)
String getInternalSubset ()
String toString ()

Protected Member Functions

 DocType ()

Protected Attributes

String elementName
String publicID
String systemID
String internalSubset

Detailed Description

An XML DOCTYPE declaration. Method allow the user to get and set the root element name, public id, and system id.

Author:
Brett McLaughlin

Jason Hunter

Version:
Revision
1.31
,
Date
2004/02/27 11:32:57


Constructor & Destructor Documentation

org::jdom::DocType::DocType  )  [inline, protected]
 

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

org::jdom::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.

org::jdom::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.

org::jdom::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

String org::jdom::DocType::getElementName  )  [inline]
 

This will retrieve the element name being constrained.

Returns:
String - element name for DOCTYPE

String org::jdom::DocType::getInternalSubset  )  [inline]
 

This returns the data for the internal subset.

Returns:
String - the internal subset

String org::jdom::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 org::jdom::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.

String org::jdom::DocType::getValue  )  [inline, virtual]
 

Returns the empty string since doctypes don't have an XPath 1.0 string value.

Returns:
the empty string

Implements org::jdom::Content.

DocType org::jdom::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 org::jdom::DocType::setInternalSubset String  newData  )  [inline]
 

This sets the data for the internal subset.

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

DocType org::jdom::DocType::setPublicID String  publicID  )  [inline]
 

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

Parameters:
publicID id to set
Returns:
DocType DocType this DocType object
Exceptions:
IllegalDataException if the given public ID is not a legal public ID.

DocType org::jdom::DocType::setSystemID String  systemID  )  [inline]
 

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

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

String org::jdom::DocType::toString  )  [inline]
 

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

Returns:
String - information about the DocType


Member Data Documentation

String org::jdom::DocType::elementName [protected]
 

The element being constrained

String org::jdom::DocType::internalSubset [protected]
 

The internal subset of the DOCTYPE

String org::jdom::DocType::publicID [protected]
 

The public ID of the DOCTYPE

String org::jdom::DocType::systemID [protected]
 

The system ID of the DOCTYPE


The documentation for this class was generated from the following file:
Generated on Thu Dec 9 10:42:04 2004 for JDOM by  doxygen 1.3.9.1