com.github.javaparser.ast.comments

Class JavadocContent

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.comments.Comment

com.github.javaparser.ast.comments.JavadocContent

All Implemented Interfaces:

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

public class JavadocContent
extends Comment

A JavaDoc content node.

Author:

Simon Sirak

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

Modifier	Constructor and Description
	JavadocContent()
	JavadocContent(JavadocDescription description, NodeList<JavadocBlockTag> blockTags)
	JavadocContent(String content, JavadocDescription description, NodeList<JavadocBlockTag> blockTags)
protected	JavadocContent(TokenRange tokenRange)
	JavadocContent(TokenRange tokenRange, String content, JavadocDescription description, NodeList<JavadocBlockTag> blockTags) 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.
void	addBlockTag(JavadocBlockTag blockTag)
JavadocContent	asJavadocContent()
JavadocContent	clone()
NodeList<JavadocBlockTag>	getBlockTags()
JavadocDescription	getDescription()
JavadocContentMetaModel	getMetaModel()
void	ifJavadocContent(Consumer<JavadocContent> action)
boolean	isJavadocContent()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
JavadocContent	setBlockTags(NodeList<JavadocBlockTag> blockTags)
JavadocContent	setDescription(JavadocDescription description)
Optional<JavadocContent>	toJavadocContent()
String	toText() Return the text content of the document.

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

asBlockComment, asJavadocComment, asLineComment, findRootNode, getCommentedNode, getContent, ifBlockComment, ifJavadocComment, ifLineComment, isBlockComment, isJavadocComment, isLineComment, isOrphan, remove, setComment, setCommentedNode, setContent, toBlockComment, toJavadocComment, toLineComment

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

addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, getToStringPrettyPrinterConfiguration, hashCode, isAncestorOf, isRegistered, notifyPropertyChange, register, register, registerForSubtree, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, setToStringPrettyPrinterConfiguration, 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, isDescendantOf

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

containsWithin, containsWithinRange, getBegin, getEnd

Constructor Detail

JavadocContent

public JavadocContent()

JavadocContent

public JavadocContent(JavadocDescription description,
                      NodeList<JavadocBlockTag> blockTags)

JavadocContent

public JavadocContent(String content,
                      JavadocDescription description,
                      NodeList<JavadocBlockTag> blockTags)

JavadocContent

public JavadocContent(TokenRange tokenRange,
                      String content,
                      JavadocDescription description,
                      NodeList<JavadocBlockTag> blockTags)

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

JavadocContent

protected JavadocContent(TokenRange tokenRange)

Method Detail

setDescription

public JavadocContent setDescription(JavadocDescription description)

setBlockTags

public JavadocContent setBlockTags(NodeList<JavadocBlockTag> blockTags)

addBlockTag

public void addBlockTag(JavadocBlockTag blockTag)

getBlockTags

public NodeList<JavadocBlockTag> getBlockTags()

getDescription

public JavadocDescription getDescription()

toText

public String toText()

Return the text content of the document. It does not contain trailing spaces or asterisks at the start of the line.

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)

isJavadocContent

public boolean isJavadocContent()

Overrides:

isJavadocContent in class Comment

asJavadocContent

public JavadocContent asJavadocContent()

Overrides:

asJavadocContent in class Comment

toJavadocContent

public Optional<JavadocContent> toJavadocContent()

Overrides:

toJavadocContent in class Comment

ifJavadocContent

public void ifJavadocContent(Consumer<JavadocContent> action)

Overrides:

ifJavadocContent in class Comment

remove

public boolean remove(Node node)

Overrides:

remove in class Comment

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Comment

clone

public JavadocContent clone()

Overrides:

clone in class Comment

getMetaModel

public JavadocContentMetaModel getMetaModel()

Overrides:

getMetaModel in class Comment

Returns:

get JavaParser specific node introspection information.