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

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

A JavaComment that has Javadoc content.

Method Summary

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

getText

public Chars getText()

Description copied from class: JavaComment

Returns the full text of the comment.

Overrides:

getText in class JavaComment

getReportLocation

public FileLocation getReportLocation()

Specified by:

getReportLocation in interface Reportable

Overrides:

getReportLocation in class JavaComment

isSingleLine

public boolean isSingleLine()

Overrides:

isSingleLine in class JavaComment

getOwner

public @Nullable JavadocCommentOwner getOwner()

Returns the owner of this comment. Null if this comment is misplaced.