com.github.javaparser.ast.comments

Class LineComment

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.Comment

com.github.javaparser.ast.comments.LineComment

All Implemented Interfaces:

NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class LineComment
extends Comment

AST node that represent line comments.

Line comments start with "//" and finish at the end of the line ("\n").

Author:

Julio Vilmar Gesser

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, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg) Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg) Accept method for visitor support.
LineComment	asLineComment()
LineComment	clone()
LineCommentMetaModel	getMetaModel()
void	ifLineComment(Consumer<LineComment> action)
boolean	isLineComment()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
Optional<LineComment>	toLineComment()

Methods inherited from class com.github.javaparser.ast.comments.Comment

asBlockComment, asJavadocComment, getCommentedNode, getContent, ifBlockComment, ifJavadocComment, isBlockComment, isJavadocComment, isOrphan, remove, setCommentedNode, setContent, toBlockComment, toJavadocComment

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

addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findParent, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, hasComment, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, removeComment, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, 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

getAncestorOfType

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

containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore

Constructor Detail

LineComment

public LineComment()

LineComment

public LineComment(String content)

LineComment

@Generated(value="com.github.javaparser.generator.core.node.MainConstructorGenerator")
public LineComment(TokenRange tokenRange,
                                                                                                          String content)

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

Method Detail

accept

@Generated(value="com.github.javaparser.generator.core.node.AcceptGenerator")
public <R,A> R accept(GenericVisitor<R,A> v,
                                                                                                    A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

@Generated(value="com.github.javaparser.generator.core.node.AcceptGenerator")
public <A> void accept(VoidVisitor<A> v,
                                                                                                     A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

isLineComment

@Generated(value="com.github.javaparser.generator.core.node.TypeCastingGenerator")
public boolean isLineComment()

Overrides:

isLineComment in class Comment

remove

@Generated(value="com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public boolean remove(Node node)

Overrides:

remove in class Comment

clone

@Generated(value="com.github.javaparser.generator.core.node.CloneGenerator")
public LineComment clone()

Overrides:

clone in class Comment

getMetaModel

@Generated(value="com.github.javaparser.generator.core.node.GetMetaModelGenerator")
public LineCommentMetaModel getMetaModel()

Overrides:

getMetaModel in class Comment

Returns:

get JavaParser specific node introspection information.

replace

@Generated(value="com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
public boolean replace(Node node,
                                                                                                            Node replacementNode)

Overrides:

replace in class Comment

asLineComment

@Generated(value="com.github.javaparser.generator.core.node.TypeCastingGenerator")
public LineComment asLineComment()

Overrides:

asLineComment in class Comment

ifLineComment

@Generated(value="com.github.javaparser.generator.core.node.TypeCastingGenerator")
public void ifLineComment(Consumer<LineComment> action)

Overrides:

ifLineComment in class Comment

toLineComment

@Generated(value="com.github.javaparser.generator.core.node.TypeCastingGenerator")
public Optional<LineComment> toLineComment()

Overrides:

toLineComment in class Comment