org.jdom

Class Comment

public class Comment extends Object implements Serializable, Cloneable

Comment defines behavior for an XML comment, modeled in Java. Methods allow the user to obtain the text of the comment.

Version: $Revision: 1.22 $, $Date: 2002/03/20 15:16:32 $

Author: Brett McLaughlin Jason Hunter

Field Summary
protected Objectparent
Parent element, document, or null if none
protected Stringtext
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
Objectclone()

This will return a clone of this Comment.

Commentdetach()

This detaches the Comment from its parent, or does nothing if the Comment has no parent.

booleanequals(Object ob)

This tests for equality of this Comment to the supplied Object.

DocumentgetDocument()

This retrieves the owning Document for this Comment, or null if not a currently a member of a Document.

ElementgetParent()

This will return the parent of this Comment.

StringgetText()

This returns the textual data within the Comment.

inthashCode()

This returns the hash code for this Comment.

protected CommentsetDocument(Document document)

This sets the Document parent of this comment.

protected CommentsetParent(Element parent)

This will set the parent of this Comment.

CommentsetText(String text)

This will set the value of the Comment.

StringtoString()

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

Field Detail

parent

protected Object parent
Parent element, document, or null if none

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

clone

public Object clone()

This will return a clone of this Comment.

Returns: Object - clone of this Comment.

detach

public Comment detach()

This detaches the Comment from its parent, or does nothing if the Comment has no parent.

Returns: Comment - this Comment modified.

equals

public final boolean equals(Object ob)

This tests for equality of this Comment to the supplied Object.

Parameters: ob Object to compare to.

Returns: boolean - whether the Comment is equal to the supplied Object.

getDocument

public Document getDocument()

This retrieves the owning Document for this Comment, or null if not a currently a member of a Document.

Returns: Document owning this Element, or null.

getParent

public Element getParent()

This will return the parent of this Comment. If there is no parent, then this returns null.

Returns: parent of this Comment

getText

public String getText()

This returns the textual data within the Comment.

Returns: String - text of comment.

hashCode

public final int hashCode()

This returns the hash code for this Comment.

Returns: int - hash code.

setDocument

protected Comment setDocument(Document document)

This sets the Document parent of this comment.

Parameters: document Document parent

Returns: this Comment modified

setParent

protected Comment setParent(Element parent)

This will set the parent of this Comment.

Parameters: parent Element to be new parent.

Returns: this Comment modified.

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

Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.