com.github.javaparser.ast.comments

Class Comment

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.Comment

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BlockComment, JavadocComment, LineComment

public abstract class Comment
extends Node

Abstract class for all AST nodes that represent comments.

Author:

Julio Vilmar Gesser

See Also:

BlockComment, LineComment, JavadocComment

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION

Constructor Summary

Constructors

Constructor and Description
Comment(Range range, String content)

Method Summary

Modifier and Type	Method and Description
LineComment	asLineComment()
Optional<Node>	getCommentedNode()
String	getContent() Return the text of the comment.
boolean	isLineComment()
boolean	isOrphan()
Comment	setCommentedNode(Node commentedNode)
Comment	setContent(String content) Sets the text of the comment.

Methods inherited from class com.github.javaparser.ast.Node

accept, accept, addOrphanComment, clone, containsWithin, equals, getAllContainedComments, getBackwardsCompatibleChildrenNodes, getBegin, getChildrenNodes, getComment, getEnd, getNodesByType, getOrphanComments, getParentNode, getParentNodeOfType, getRange, getUserData, hashCode, isPositionedAfter, isPositionedBefore, remove, setAsParentNodeOf, setAsParentNodeOf, setAsParentNodeOf, setBegin, setBlockComment, setComment, setEnd, setLineComment, setParentNode, setRange, setUserData, toString, toStringWithoutComments, tryAddImportToParentCompilationUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

Comment

public Comment(Range range,
               String content)

Method Detail

getContent

public final String getContent()

Return the text of the comment.

Returns:

text of the comment

setContent

public Comment setContent(String content)

Sets the text of the comment.

Parameters:

content - the text of the comment to set

isLineComment

public boolean isLineComment()

asLineComment

public LineComment asLineComment()

getCommentedNode

public Optional<Node> getCommentedNode()

setCommentedNode

public Comment setCommentedNode(Node commentedNode)

isOrphan

public boolean isOrphan()