JDOM 2.0.6.1 · org.jdom2.Comment

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.jdom2.Content.serialVersionUID. JDOM2 Serialization.
protected String	text Text of the `Comment`

Access	Constructor and Description
protected	Comment() Default, no-args constructor for implementations to use if needed.
public	Comment(String `String` content of comment. text) This creates the comment with the supplied text.

Method Summary

Modifier and Type	Method and Description
public Comment	clone() Overrides org.jdom2.Content.clone. Return a deep clone of this instance.
public Comment	detach() Overrides org.jdom2.Content.detach. Detaches this child from its parent or does nothing if the child has no parent.
public String	Returns: `String` - text of comment. getText() This returns the textual data within the `Comment`.
public String	Returns: the text of this comment getValue() Implements abstract org.jdom2.Content.getValue. Returns the XPath 1.0 string value of this element, which is the text of this comment.
protected Comment	setParent(Parent new parent element parent) Overrides org.jdom2.Content.setParent. Sets the parent of this Content.
public Comment	Returns: `Comment` - this Comment modified. setText(String `String` text for comment. text) This will set the value of the `Comment`.
public String	Returns: `String` - information about the `Comment` toString() Overrides java.lang.Object.toString. This returns a `String` representation of the `Comment`, suitable for debugging.

Inherited from org.jdom2.Content:: equals getCType getDocument getNamespacesInherited getNamespacesInScope getNamespacesIntroduced getParent getParentElement hashCode

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.jdom2.Content.serialVersionUID. JDOM2 Serialization. In this case, Comment is simple.

text	back to summary
protected String text Text of the `Comment`

Comment	back to summary
protected Comment() Default, no-args constructor for implementations to use if needed.

Comment	back to summary
public Comment(String text) This creates the comment with the supplied text. Parameters text:String `String` content of comment.

Method Detail

clone	back to summary
public Comment clone() Overrides org.jdom2.Content.clone. Doc from org.jdom2.CloneBase.clone. Return a deep clone of this instance. Even if this instance has a parent, the returned clone will not. All JDOM core classes are Cloneable, and never throw CloneNotSupportedException. Additionally all Cloneable JDOM classes return the correct type of instance from this method and there is no need to cast the result (co-variant return value). Subclasses of this should still call super.clone() in their clone method. Returns:Comment Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Comment clone()

Overrides org.jdom2.Content.clone.

Doc from org.jdom2.CloneBase.clone.

Return a deep clone of this instance. Even if this instance has a parent, the returned clone will not.

All JDOM core classes are Cloneable, and never throw CloneNotSupportedException. Additionally all Cloneable JDOM classes return the correct type of instance from this method and there is no need to cast the result (co-variant return value).

Subclasses of this should still call super.clone() in their clone method.

Returns:Comment

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

detach back to summary

detach	back to summary
public Comment detach() Overrides org.jdom2.Content.detach. Doc from org.jdom2.Content.detach. Detaches this child from its parent or does nothing if the child has no parent. This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call `super.detach()`; Returns:Comment this child detached Annotations @Override

public Comment detach()

Overrides org.jdom2.Content.detach.

Doc from org.jdom2.Content.detach.

Detaches this child from its parent or does nothing if the child has no parent.

This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call super.detach();

Returns:Comment

this child detached

Annotations

@Override

getText back to summary

getText	back to summary
public String getText() This returns the textual data within the `Comment`. Returns:String `String` - text of comment.

public String getText()

This returns the textual data within the Comment.

Returns:String: String - text of comment.

getValue	back to summary
public String getValue() Implements abstract org.jdom2.Content.getValue. Returns the XPath 1.0 string value of this element, which is the text of this comment. Returns:String the text of this comment Annotations @Override

getValue

back to summary

public String getValue()

Implements abstract org.jdom2.Content.getValue.

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

Returns:String

the text of this comment

Annotations

@Override

setParent back to summary

setParent	back to summary
protected Comment setParent(Parent parent) Overrides org.jdom2.Content.setParent. Doc from org.jdom2.Content.setParent. Sets the parent of this Content. The caller is responsible for removing any pre-existing parentage. This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call `super.setParent(Parent)`; Parameters parent:Parent new parent element Returns:Comment the target element Annotations @Override

protected Comment setParent(Parent parent)

Overrides org.jdom2.Content.setParent.

Doc from org.jdom2.Content.setParent.

Sets the parent of this Content. The caller is responsible for removing any pre-existing parentage.

This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call super.setParent(Parent);

Parameters

parent:Parent: new parent element

Returns:Comment

the target element

Annotations

@Override

setText back to summary

setText	back to summary
public Comment setText(String text) This will set the value of the `Comment`. Parameters text:String `String` text for comment. Returns:Comment `Comment` - this Comment modified. Exceptions IllegalDataException: if the given text is illegal for a Comment.

public Comment setText(String text)

This will set the value of the Comment.

Parameters

text:String: String text for comment.

Returns:Comment

Comment - this Comment modified.

Exceptions

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

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. This returns a `String` representation of the `Comment`, suitable for debugging. If the XML representation of the `Comment` is desired, `org.jdom2.output.XMLOutputter#outputString(Comment)` should be used. Returns:String `String` - information about the `Comment` Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String

String - information about the Comment

Annotations

@Override

public Class Comment

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail