Package com.github.javaparser.ast.comments

Class Comment

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.Comment

All Implemented Interfaces:

NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, java.lang.Cloneable

Direct Known Subclasses:

BlockComment, JavadocComment, LineComment

public abstract class Comment
extends Node

Abstract class for all AST nodes that represent comments.

See Also:

BlockComment, LineComment, MarkdownComment, TraditionalJavadocComment

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

Fields

Modifier and Type	Field	Description
private Node	commentedNode
private java.lang.String	content

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
Comment(TokenRange tokenRange, java.lang.String content)	This constructor is used by the parser and is considered private.
Comment(java.lang.String content)

Method Summary

Modifier and Type	Method	Description
BlockComment	asBlockComment()
JavadocComment	asJavadocComment()
LineComment	asLineComment()
MarkdownComment	asMarkdownComment()
java.lang.String	asString()
TraditionalJavadocComment	asTraditionalJavadocComment()
Comment	clone()
Node	findRootNode()	Finds the root node of this AST by finding the topmost parent.
java.util.Optional<Node>	getCommentedNode()
java.lang.String	getContent()	Return the text of the comment.
abstract java.lang.String	getFooter()
abstract java.lang.String	getHeader()
CommentMetaModel	getMetaModel()
void	ifBlockComment(java.util.function.Consumer<BlockComment> action)
void	ifJavadocComment(java.util.function.Consumer<JavadocComment> action)
void	ifLineComment(java.util.function.Consumer<LineComment> action)
void	ifMarkdownComment(java.util.function.Consumer<MarkdownComment> action)
void	ifTraditionalJavadocComment(java.util.function.Consumer<TraditionalJavadocComment> action)
boolean	isBlockComment()
boolean	isJavadocComment()
boolean	isLineComment()
boolean	isMarkdownComment()
boolean	isOrphan()
boolean	isTraditionalJavadocComment()
boolean	remove()	Try to remove this node from the parent
Node	setComment(Comment comment)	Use this to store additional information to this node.
Comment	setCommentedNode(Node commentedNode)	Sets the commentedNode
Comment	setContent(java.lang.String content)	Sets the text of the comment.
java.util.Optional<BlockComment>	toBlockComment()
java.util.Optional<JavadocComment>	toJavadocComment()
java.util.Optional<LineComment>	toLineComment()
java.util.Optional<MarkdownComment>	toMarkdownComment()
java.util.Optional<TraditionalJavadocComment>	toTraditionalJavadocComment()

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

addOrphanComment, containsData, createDefaultPrinter, createDefaultPrinter, customInitialization, equals, findAll, findAll, findAll, findByRange, findCompilationUnit, findData, findFirst, findFirst, findFirst, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getDefaultPrinterConfiguration, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getPrinter, getPrinter, getRange, getSymbolResolver, getTokenRange, hashCode, hasScope, isAncestorOf, isPhantom, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Methods inherited from interface com.github.javaparser.ast.visitor.Visitable

accept, accept

Field Detail

content

private java.lang.String content

commentedNode

private Node commentedNode

Constructor Detail

Comment

public Comment(java.lang.String content)

Comment

public Comment(TokenRange tokenRange,
               java.lang.String content)

This constructor is used by the parser and is considered private.

Method Detail

getContent

public java.lang.String getContent()

Return the text of the comment.

Returns:

text of the comment

setContent

public Comment setContent(java.lang.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 java.util.Optional<Node> getCommentedNode()

setCommentedNode

public Comment setCommentedNode(Node commentedNode)

Sets the commentedNode

Parameters:

commentedNode - the commentedNode, can be null

Returns:

this, the Comment

isOrphan

public boolean isOrphan()

setComment

public Node setComment(Comment comment)

Description copied from class: Node

Use this to store additional information to this node.

Overrides:

setComment in class Node

Parameters:

comment - to be set

remove

public boolean remove()

Description copied from class: Node

Try to remove this node from the parent

Overrides:

remove in class Node

Returns:

true if removed, false if it is a required property of the parent, or if the parent isn't set.

findRootNode

public Node findRootNode()

Description copied from class: Node

Finds the root node of this AST by finding the topmost parent.

Overrides:

findRootNode in class Node

clone

public Comment clone()

Overrides:

clone in class Node

getMetaModel

public CommentMetaModel getMetaModel()

Overrides:

getMetaModel in class Node

Returns:

get JavaParser specific node introspection information.

isBlockComment

public boolean isBlockComment()

asBlockComment

public BlockComment asBlockComment()

isJavadocComment

public boolean isJavadocComment()

asJavadocComment

public JavadocComment asJavadocComment()

ifBlockComment

public void ifBlockComment(java.util.function.Consumer<BlockComment> action)

ifJavadocComment

public void ifJavadocComment(java.util.function.Consumer<JavadocComment> action)

ifLineComment

public void ifLineComment(java.util.function.Consumer<LineComment> action)

toBlockComment

public java.util.Optional<BlockComment> toBlockComment()

toJavadocComment

public java.util.Optional<JavadocComment> toJavadocComment()

toLineComment

public java.util.Optional<LineComment> toLineComment()

getHeader

public abstract java.lang.String getHeader()

getFooter

public abstract java.lang.String getFooter()

asString

public java.lang.String asString()

isMarkdownComment

public boolean isMarkdownComment()

asMarkdownComment

public MarkdownComment asMarkdownComment()

toMarkdownComment

public java.util.Optional<MarkdownComment> toMarkdownComment()

ifMarkdownComment

public void ifMarkdownComment(java.util.function.Consumer<MarkdownComment> action)

isTraditionalJavadocComment

public boolean isTraditionalJavadocComment()

asTraditionalJavadocComment

public TraditionalJavadocComment asTraditionalJavadocComment()

toTraditionalJavadocComment

public java.util.Optional<TraditionalJavadocComment> toTraditionalJavadocComment()

ifTraditionalJavadocComment

public void ifTraditionalJavadocComment(java.util.function.Consumer<TraditionalJavadocComment> action)