com.puppycrawl.tools.checkstyle.checks

Class NoCodeInFileCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class NoCodeInFileCheck
extends AbstractCheck

Checks whether file contains code. Files which are considered to have no code:

• File with no text
• File with single line comment(s)
• File with a multi line comment(s).

To configure the check:

 <module name="NoCodeInFile"/>
 

Example:

Content of the files:

 // single line comment // violation
 

 /* // violation
  block comment
 */
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• nocode.in.file

Since:

8.33

Nested Class Summary

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

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_LINE_NUMBER Line number used to log violation when no AST nodes are present in file.
static java.lang.String	MSG_KEY_NO_CODE A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
NoCodeInFileCheck()

Method Summary

Modifier and Type	Method and Description
void	finishTree(DetailAST ast) Called after finished processing a tree.
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.

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

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

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.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY_NO_CODE

public static final java.lang.String MSG_KEY_NO_CODE

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

See Also:

Constant Field Values

DEFAULT_LINE_NUMBER

private static final int DEFAULT_LINE_NUMBER

Line number used to log violation when no AST nodes are present in file.

See Also:

Constant Field Values

Constructor Detail

NoCodeInFileCheck

public NoCodeInFileCheck()

Method Detail

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

finishTree

public void finishTree(DetailAST ast)

Description copied from class: AbstractCheck

Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.

Overrides:

finishTree in class AbstractCheck

Parameters:

ast - the root of the tree