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 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, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, PHANTOM_KEY, prettyPrinterNoCommentsConfiguration, PRINTER_KEY, 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()
String	getFooter()
String	getHeader()
LineCommentMetaModel	getMetaModel()
void	ifLineComment(Consumer<LineComment> action)
boolean	isLineComment()
Optional<LineComment>	toLineComment()

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

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

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

Constructor Detail

LineComment

public LineComment()

LineComment

public LineComment(String content)

LineComment

public LineComment(TokenRange tokenRange,
                   String content)

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

Method Detail

accept

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

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

public boolean isLineComment()

Overrides:

isLineComment in class Comment

clone

public LineComment clone()

Overrides:

clone in class Comment

getMetaModel

public LineCommentMetaModel getMetaModel()

Overrides:

getMetaModel in class Comment

Returns:

get JavaParser specific node introspection information.

asLineComment

public LineComment asLineComment()

Overrides:

asLineComment in class Comment

ifLineComment

public void ifLineComment(Consumer<LineComment> action)

Overrides:

ifLineComment in class Comment

toLineComment

public Optional<LineComment> toLineComment()

Overrides:

toLineComment in class Comment

getHeader

public String getHeader()

Specified by:

getHeader in class Comment

getFooter

public String getFooter()

Specified by:

getFooter in class Comment