Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class MissingJavadocPackageCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MissingJavadocPackageCheck
extends AbstractCheck

Checks for missing package definition Javadoc comments in package-info.java files.

Rationale: description and other related documentation for a package can be written up in the package-info.java file and it gets used in the production of the Javadocs. See link for more info.

This check specifically only validates package definitions. It will not validate any methods or interfaces declared in the package-info.java file.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• package.javadoc.missing

Since:

8.22

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_PKG_JAVADOC_MISSING	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
MissingJavadocPackageCheck()

Method Summary

Modifier and Type	Method	Description
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
private static boolean	hasJavadoc(DetailAST ast)	Checks that there is javadoc before ast.
private static boolean	hasJavadocAboveAnnotation(DetailAST ast)	Checks javadoc existence in annotations list.
boolean	isCommentNodesRequired()	Whether comment nodes are required or not.
private static boolean	isJavadoc(DetailAST ast)	Checks that ast is a javadoc comment.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Details

MSG_PKG_JAVADOC_MISSING

public static final String MSG_PKG_JAVADOC_MISSING

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

Constructor Details

MissingJavadocPackageCheck

public MissingJavadocPackageCheck()

Method Details

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

See Also:

• TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

• TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

• TokenTypes

isCommentNodesRequired

public boolean isCommentNodesRequired()

Description copied from class: AbstractCheck

Whether comment nodes are required or not.

Overrides:

isCommentNodesRequired in class AbstractCheck

Returns:

false as a default value.

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

hasJavadoc

private static boolean hasJavadoc(DetailAST ast)

Checks that there is javadoc before ast. Because of parser bug parser can place javadoc comment either as previous sibling of package definition or (if there is annotation between package def and javadoc) inside package definition tree. So we should look for javadoc in both places.

Parameters:

ast - TokenTypes.PACKAGE_DEF token to check

Returns:

true if there is javadoc, false otherwise

hasJavadocAboveAnnotation

private static boolean hasJavadocAboveAnnotation(DetailAST ast)

Checks javadoc existence in annotations list.

Parameters:

ast - package def

Returns:

true if there is a javadoc, false otherwise

isJavadoc

private static boolean isJavadoc(DetailAST ast)

Checks that ast is a javadoc comment.

Parameters:

ast - token to check

Returns:

true if ast is a javadoc comment, false otherwise