Class JavadocComment
- java.lang.Object
-
- net.sourceforge.pmd.lang.java.ast.JavaComment
-
- net.sourceforge.pmd.lang.java.ast.JavadocComment
-
- All Implemented Interfaces:
Reportable
public final class JavadocComment extends JavaComment
AJavaComment
that has Javadoc content.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @Nullable JavadocCommentOwner
getOwner()
Returns the owner of this comment.FileLocation
getReportLocation()
Chars
getText()
Returns the full text of the comment.boolean
isSingleLine()
-
Methods inherited from class net.sourceforge.pmd.lang.java.ast.JavaComment
equals, getFilteredLines, getFilteredLines, getLeadingComments, getToken, hashCode, hasJavadocContent, isComment, isMarkupWord, removeCommentMarkup
-
-
-
-
Method Detail
-
getText
public Chars getText()
Description copied from class:JavaComment
Returns the full text of the comment.- Overrides:
getText
in classJavaComment
-
getReportLocation
public FileLocation getReportLocation()
- Specified by:
getReportLocation
in interfaceReportable
- Overrides:
getReportLocation
in classJavaComment
-
isSingleLine
public boolean isSingleLine()
- Overrides:
isSingleLine
in classJavaComment
-
getOwner
public @Nullable JavadocCommentOwner getOwner()
Returns the owner of this comment. Null if this comment is misplaced.
-
-