Top Description Methods
com.github.javaparser.ast.nodeTypes

public Interface NodeWithJavadoc<N extends Node>

Known Direct Implementers
com.github.javaparser.ast.body.AnnotationMemberDeclaration, com.github.javaparser.ast.body.CallableDeclaration, com.github.javaparser.ast.body.ConstructorDeclaration, com.github.javaparser.ast.body.EnumConstantDeclaration, com.github.javaparser.ast.body.FieldDeclaration, com.github.javaparser.ast.body.InitializerDeclaration, com.github.javaparser.ast.body.MethodDeclaration, com.github.javaparser.ast.body.TypeDeclaration
Imports
com.github.javaparser.ast.Node, com.github.javaparser.ast.comments.Comment, .JavadocComment, com.github.javaparser.javadoc.Javadoc, java.util.Optional
A node that can be documented with a Javadoc comment.

Method Summary

Modifier and TypeMethod and Description
public Optional<Comment>
getComment()

public default Optional<Javadoc>

Returns:

The Javadoc for this node wrapped in an optional as it may be absent.
getJavadoc()

Gets the Javadoc for this node.

public default Optional<JavadocComment>

Returns:

The JavadocComment for this node wrapped in an optional as it may be absent.
getJavadocComment()

Gets the JavadocComment for this node.

public default boolean
hasJavaDocComment()

public default boolean
removeJavaDocComment()

public Node
setComment(Comment comment)

public default N
setJavadocComment(String
to be set
comment)

Use this to store additional information to this node.

public default N
setJavadocComment(JavadocComment comment)

public default N
setJavadocComment(String indentation, Javadoc javadoc)

public default N
setJavadocComment(Javadoc javadoc)

Method Detail

getCommentback to summary
public Optional<Comment> getComment()
getJavadocback to summary
public default Optional<Javadoc> getJavadoc()

Gets the Javadoc for this node. You can set the Javadoc by calling setJavadocComment passing a Javadoc.

Returns:Optional<Javadoc>

The Javadoc for this node wrapped in an optional as it may be absent.

getJavadocCommentback to summary
public default Optional<JavadocComment> getJavadocComment()

Gets the JavadocComment for this node. You can set the JavadocComment by calling setJavadocComment passing a JavadocComment.

Returns:Optional<JavadocComment>

The JavadocComment for this node wrapped in an optional as it may be absent.

hasJavaDocCommentback to summary
public default boolean hasJavaDocComment()
removeJavaDocCommentback to summary
public default boolean removeJavaDocComment()
setCommentback to summary
public Node setComment(Comment comment)
setJavadocCommentback to summary
public default N setJavadocComment(String comment)

Use this to store additional information to this node.

Parameters
comment:String

to be set

Annotations
@SuppressWarnings:unchecked
setJavadocCommentback to summary
public default N setJavadocComment(JavadocComment comment)
setJavadocCommentback to summary
public default N setJavadocComment(String indentation, Javadoc javadoc)
setJavadocCommentback to summary
public default N setJavadocComment(Javadoc javadoc)