Class 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
  • Field Details

    • MSG_KEY_NO_CODE

      public static final String MSG_KEY_NO_CODE
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
  • Constructor Details

    • NoCodeInFileCheck

      public NoCodeInFileCheck()
  • 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:
    • 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:
    • 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:
    • 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