com.github.javaparser.ast.comments

Class BlockComment

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.Comment

com.github.javaparser.ast.comments.BlockComment

All Implemented Interfaces:

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

public class BlockComment
extends Comment

AST node that represent block comments.

Block comments can have multi lines and are delimited by "/*" and "*/".

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
BlockComment()
BlockComment(String content)
BlockComment(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.
BlockComment	asBlockComment()
BlockComment	clone()
String	getFooter()
String	getHeader()
BlockCommentMetaModel	getMetaModel()
void	ifBlockComment(Consumer<BlockComment> action)
boolean	isBlockComment()
Optional<BlockComment>	toBlockComment()

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

asJavadocComment, asLineComment, asString, findRootNode, getCommentedNode, getContent, ifJavadocComment, ifLineComment, isJavadocComment, isLineComment, isOrphan, remove, setComment, setCommentedNode, setContent, toJavadocComment, 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.nodeTypes.NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Constructor Detail

BlockComment

public BlockComment()

BlockComment

public BlockComment(String content)

BlockComment

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

clone

public BlockComment clone()

Overrides:

clone in class Comment

getMetaModel

public BlockCommentMetaModel getMetaModel()

Overrides:

getMetaModel in class Comment

Returns:

get JavaParser specific node introspection information.

isBlockComment

public boolean isBlockComment()

Overrides:

isBlockComment in class Comment

asBlockComment

public BlockComment asBlockComment()

Overrides:

asBlockComment in class Comment

ifBlockComment

public void ifBlockComment(Consumer<BlockComment> action)

Overrides:

ifBlockComment in class Comment

toBlockComment

public Optional<BlockComment> toBlockComment()

Overrides:

toBlockComment in class Comment

getHeader

public String getHeader()

Specified by:

getHeader in class Comment

getFooter

public String getFooter()

Specified by:

getFooter in class Comment