Class JavadocComment

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.Comment

com.github.javaparser.ast.comments.JavadocComment

All Implemented Interfaces:

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

Direct Known Subclasses:

MarkdownComment, TraditionalJavadocComment

public abstract class JavadocComment
extends Comment

Nested Class Summary

Nested classes/interfaces inherited from class Node

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

Field Summary

Fields inherited from class 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
JavadocComment()
JavadocComment(TokenRange tokenRange, String content)	This constructor is used by the parser and is considered private.
JavadocComment(String content)

Method Summary

Modifier and Type	Method	Description
JavadocComment	asJavadocComment()
JavadocComment	clone()
JavadocCommentMetaModel	getMetaModel()
void	ifJavadocComment(Consumer<JavadocComment> action)
boolean	isJavadocComment()
Javadoc	parse()
Optional<JavadocComment>	toJavadocComment()

Methods inherited from class Comment

asBlockComment, asLineComment, asMarkdownComment, asString, asTraditionalJavadocComment, findRootNode, getCommentedNode, getContent, getFooter, getHeader, ifBlockComment, ifLineComment, ifMarkdownComment, ifTraditionalJavadocComment, isBlockComment, isLineComment, isMarkdownComment, isOrphan, isTraditionalJavadocComment, remove, setComment, setCommentedNode, setContent, toBlockComment, toLineComment, toMarkdownComment, toTraditionalJavadocComment

Methods inherited from class 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 Object

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

Methods inherited from interface HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface NodeWithRange

containsWithin, containsWithinRange, getBegin, getEnd, hasRange

Methods inherited from interface Visitable

accept, accept

Constructor Details

JavadocComment

public JavadocComment()

JavadocComment

public JavadocComment(String content)

JavadocComment

public JavadocComment(TokenRange tokenRange,
 String content)

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

Method Details

isJavadocComment

public boolean isJavadocComment()

Overrides:

isJavadocComment in class Comment

asJavadocComment

public JavadocComment asJavadocComment()

Overrides:

asJavadocComment in class Comment

toJavadocComment

public Optional<JavadocComment> toJavadocComment()

Overrides:

toJavadocComment in class Comment

ifJavadocComment

public void ifJavadocComment(Consumer<JavadocComment> action)

Overrides:

ifJavadocComment in class Comment

clone

public JavadocComment clone()

Overrides:

clone in class Comment

getMetaModel

public JavadocCommentMetaModel getMetaModel()

Overrides:

getMetaModel in class Comment

Returns:

get JavaParser specific node introspection information.

parse

public Javadoc parse()