org.jdom
Class Comment

java.lang.Object
  org.jdom.Content
      org.jdom.Comment

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

protected String

text Text of the Comment

Fields inherited from class org.jdom.Content

parent

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.

Methods inherited from class org.jdom.Content

clone, detach, equals, getDocument, getParent, getParentElement, hashCode, setParent

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getValue

public String getValue()

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

Specified by:

getValue in class Content

Returns:

the text of this comment

getText

public String getText()

This returns the textual data within the Comment.

Returns:

String - text of 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, XMLOutputter.outputString(Comment) should be used.

Overrides:

toString in class Object

Returns:

String - information about the Attribute