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>, 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

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 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 and Description
Comment(String content)
Comment(TokenRange tokenRange, String content) This constructor is used by the parser and is considered private.

Method Summary

Modifier and Type	Method and Description
BlockComment	asBlockComment()
JavadocComment	asJavadocComment()
LineComment	asLineComment()
String	asString()
Comment	clone()
Node	findRootNode() Finds the root node of this AST by finding the topmost parent.
Optional<Node>	getCommentedNode()
String	getContent() Return the text of the comment.
abstract String	getFooter()
abstract String	getHeader()
CommentMetaModel	getMetaModel()
void	ifBlockComment(Consumer<BlockComment> action)
void	ifJavadocComment(Consumer<JavadocComment> action)
void	ifLineComment(Consumer<LineComment> action)
boolean	isBlockComment()
boolean	isJavadocComment()
boolean	isLineComment()
boolean	isOrphan()
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(String content) Sets the text of the comment.
Optional<BlockComment>	toBlockComment()
Optional<JavadocComment>	toJavadocComment()
Optional<LineComment>	toLineComment()

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.visitor.Visitable

accept, accept

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

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

Comment

public Comment(String content)

Comment

public Comment(TokenRange tokenRange,
               String content)

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

Method Detail

getContent

public 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)

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(Consumer<BlockComment> action)

ifJavadocComment

public void ifJavadocComment(Consumer<JavadocComment> action)

ifLineComment

public void ifLineComment(Consumer<LineComment> action)

toBlockComment

public Optional<BlockComment> toBlockComment()

toJavadocComment

public Optional<JavadocComment> toJavadocComment()

toLineComment

public Optional<LineComment> toLineComment()

getHeader

public abstract String getHeader()

getFooter

public abstract String getFooter()

asString

public String asString()