Main Page | Class Hierarchy | Class List | Class Members

org::jdom::Comment Class Reference

Inheritance diagram for org::jdom::Comment:

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

Public Member Functions

 Comment (String text)
String getValue ()
String getText ()
Comment setText (String text)
String toString ()

Protected Member Functions

 Comment ()

Protected Attributes

String text

Detailed Description

An XML comment. Methods allow the user to get and set the text of the comment.

Version:
Revision
1.32
,
Date
2004/02/11 21:12:43
Author:
Brett McLaughlin

Jason Hunter


Constructor & Destructor Documentation

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

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

org::jdom::Comment::Comment String  text  )  [inline]
 

This creates the comment with the supplied text.

Parameters:
text String content of comment.


Member Function Documentation

String org::jdom::Comment::getText  )  [inline]
 

This returns the textual data within the Comment.

Returns:
String - text of comment.

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

Returns the XPath 1.0 string value of this element, which is the text of this comment.

Returns:
the text of this comment

Implements org::jdom::Content.

Comment org::jdom::Comment::setText String  text  )  [inline]
 

This will set the value of the Comment.

Parameters:
text String text for comment.
Returns:
Comment - this Comment modified.
Exceptions:
IllegalDataException if the given text is illegal for a Comment.

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

This returns a String representation of the Comment, suitable for debugging. If the XML representation of the Comment is desired, org.jdom.output.XMLOutputter#outputString(Comment) should be used.

Returns:
String - information about the Attribute


Member Data Documentation

String org::jdom::Comment::text [protected]
 

Text of the Comment


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