Top Description Constructors Methods
com.github.javaparser.ast.comments

public Class JavadocComment

extends Comment
Class Inheritance
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Node, .Generated, com.github.javaparser.ast.visitor.GenericVisitor, .VoidVisitor, .CloneVisitor, com.github.javaparser.javadoc.Javadoc, com.github.javaparser.metamodel.JavadocCommentMetaModel, .JavaParserMetaModel, com.github.javaparser.TokenRange, java.util.function.Consumer, java.util.Optional
A Javadoc comment. /** a comment */
Author
Julio Vilmar Gesser

Constructor Summary

AccessConstructor and Description
public
JavadocComment()

public
JavadocComment(String content)

public
JavadocComment(TokenRange tokenRange, String content)

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

Method Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public JavadocComment
asJavadocComment()

Overrides com.github.javaparser.ast.comments.Comment.asJavadocComment.

public JavadocComment
clone()

Overrides com.github.javaparser.ast.comments.Comment.clone.

Creates and returns a copy of this object.
public JavadocCommentMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.comments.Comment.getMetaModel.

public void
ifJavadocComment(Consumer<JavadocComment> action)

Overrides com.github.javaparser.ast.comments.Comment.ifJavadocComment.

public boolean
isJavadocComment()

Overrides com.github.javaparser.ast.comments.Comment.isJavadocComment.

public Javadoc
parse()

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.comments.Comment.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.comments.Comment.replace.

public Optional<JavadocComment>
toJavadocComment()

Overrides com.github.javaparser.ast.comments.Comment.toJavadocComment.

Inherited from com.github.javaparser.ast.comments.Comment:
asBlockCommentasLineCommentfindRootNodegetCommentedNodegetContentifBlockCommentifLineCommentisBlockCommentisLineCommentisOrphanremovesetCommentsetCommentedNodesetContenttoBlockCommenttoLineComment

Constructor Detail

JavadocCommentback to summary
public JavadocComment()
JavadocCommentback to summary
public JavadocComment(String content)
Annotations
@AllFieldsConstructor
JavadocCommentback to summary
public JavadocComment(TokenRange tokenRange, String content)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
asJavadocCommentback to summary
public JavadocComment asJavadocComment()

Overrides com.github.javaparser.ast.comments.Comment.asJavadocComment.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public JavadocComment clone()

Overrides com.github.javaparser.ast.comments.Comment.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:JavadocComment

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getMetaModelback to summary
public JavadocCommentMetaModel getMetaModel()

Overrides com.github.javaparser.ast.comments.Comment.getMetaModel.

Returns:JavadocCommentMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifJavadocCommentback to summary
public void ifJavadocComment(Consumer<JavadocComment> action)

Overrides com.github.javaparser.ast.comments.Comment.ifJavadocComment.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isJavadocCommentback to summary
public boolean isJavadocComment()

Overrides com.github.javaparser.ast.comments.Comment.isJavadocComment.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
parseback to summary
public Javadoc parse()
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.comments.Comment.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.comments.Comment.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
toJavadocCommentback to summary
public Optional<JavadocComment> toJavadocComment()

Overrides com.github.javaparser.ast.comments.Comment.toJavadocComment.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator