|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--org.jdom.Comment
Comment defines behavior for an XML
comment, modeled in Java. Methods
allow the user to obtain the text of the comment.
| Field Summary | |
protected Document |
document
Document node if comment is outside the root element, or null if none |
protected Element |
parent
Parent node, or null if none |
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 | |
Object |
clone()
This will return a clone of this Comment. |
Comment |
detach()
This detaches the Comment from its parent, or does
nothing if the Comment has no parent. |
boolean |
equals(Object ob)
This tests for equality of this Comment to the supplied
Object. |
Document |
getDocument()
This retrieves the owning for
this Comment, or null if not a currently a member of a
. |
Element |
getParent()
This will return the parent of this Comment. |
String |
getSerializedForm()
Deprecated. Deprecated in beta7, use XMLOutputter.outputString(Comment) instead |
String |
getText()
This returns the textual data within the Comment. |
int |
hashCode()
This returns the hash code for this Comment. |
protected Comment |
setDocument(Document document)
This sets the parent of this comment. |
protected Comment |
setParent(Element parent)
This will set the parent 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 java.lang.Object |
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
| Field Detail |
protected String text
Commentprotected Element parent
protected Document document
| Constructor Detail |
protected Comment()
Default, no-args constructor for implementations to use if needed.
public Comment(String text)
This creates the comment with the supplied text.
text - String content of comment.| Method Detail |
public Element getParent()
This will return the parent of this Comment.
If there is no parent, then this returns null.
Commentprotected Comment setParent(Element parent)
This will set the parent of this Comment.
parent - Element to be new parent.Comment modified.public Comment detach()
This detaches the Comment from its parent, or does
nothing if the Comment has no parent.
Comment - this
Comment modified.public Document getDocument()
This retrieves the owning for
this Comment, or null if not a currently a member of a
Document.
Document
Document owning this Element, or null.protected Comment setDocument(Document document)
This sets the parent of this comment.
Document
document - Document parentComment modifiedpublic String getText()
This returns the textual data within the
Comment.
String - text of comment.public Comment setText(String text)
This will set the value of the Comment.
text - String text for comment.Comment - this Comment modified.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.
String - information about the
Attributepublic final boolean equals(Object ob)
This tests for equality of this Comment to the supplied
Object.
ob - Object to compare to.boolean - whether the Comment is
equal to the supplied Object.public final int hashCode()
This returns the hash code for this Comment.
int - hash code.public Object clone()
This will return a clone of this Comment.
Object - clone of this Comment.public final String getSerializedForm()
This will return the Comment in XML format,
usable in an XML document.
String - the serialized form of the
Comment.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||