org.jdom

Class Comment

public class Comment extends Content

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

Version: $Revision: 1.33 $, $Date: 2007/11/10 05:28:58 $

Author: Brett McLaughlin Jason Hunter

Field Summary
protected String	text Text of the `Comment`

Constructor Summary
protected	Comment() Default, no-args constructor for implementations to use if needed.
	Comment(String text) This creates the comment with the supplied text.

Method Summary
String	getText() This returns the textual data within the `Comment`.
String	getValue() Returns the XPath 1.0 string value of this element, which is the text of this comment.
Comment	setText(String text) This will set the value of the `Comment`.
String	toString() This returns a `String` representation of the `Comment`, suitable for debugging.

Field Detail

text

protected String text

Text of the Comment

Constructor Detail

Comment

protected Comment()

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

Comment

public Comment(String text)

This creates the comment with the supplied text.

Parameters: text String content of comment.

Method Detail

getText

public String getText()

This returns the textual data within the Comment.

Returns: String - text of comment.

getValue

public String getValue()

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

Returns: the text of this comment

setText

public Comment setText(String text)

This will set the value of the Comment.

Parameters: text String text for comment.

Returns: Comment - this Comment modified.

Throws: IllegalDataException if the given text is illegal for a Comment.

toString

public String toString()

This returns a String representation of the Comment, suitable for debugging. If the XML representation of the Comment is desired, outputString should be used.

Returns: String - information about the Attribute