Package net.sourceforge.pmd.lang.java.ast

Interface JavadocCommentOwner

All Superinterfaces:

GenericNode<JavaNode>, JavaNode, JjtreeNode<JavaNode>, Node, Reportable, TextAvailableNode

All Known Subinterfaces:

ASTExecutableDeclaration, ASTTypeDeclaration

All Known Implementing Classes:

ASTAnnotationTypeDeclaration, ASTAnonymousClassDeclaration, ASTClassDeclaration, ASTCompactConstructorDeclaration, ASTConstructorDeclaration, ASTEnumConstant, ASTEnumDeclaration, ASTFieldDeclaration, ASTImplicitClassDeclaration, ASTMethodDeclaration, ASTModuleDeclaration, ASTPackageDeclaration, ASTRecordDeclaration

public interface JavadocCommentOwner
extends JavaNode

A node that may own a javadoc comment.

Field Summary

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
default @Nullable JavadocComment	getJavadocComment()	Returns the javadoc comment that applies to this declaration.

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode

getEnclosingType, getRoot, getSymbolTable, getTypeSystem

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode

getFirstToken, getLastToken, tokens

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

acceptVisitor, ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary

Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode

getOriginalText, getText, getTextRegion

Method Details

getJavadocComment

default @Nullable JavadocComment getJavadocComment()

Returns the javadoc comment that applies to this declaration. If there is none, returns null.