Class EmptyLinesCheck

  • All Implemented Interfaces:
    com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

    public final class EmptyLinesCheck
    extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
    Check for empty lines inside methods and constructors.

    We believe that comments and empty lines are evil. If you need to use an empty line in order to add a vertical separator of concepts - refactor your code and make it more cohesive and readable. The bottom line is that every method should look solid and do just one thing. This class is thread safe. It relies on building a list of line ranges by visiting each method definition and each anonymous inner type. It stores these references in a non-static thread local.

    Since:
    0.3
    • Nested Class Summary

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

        com.puppycrawl.tools.checkstyle.AbstractAutomaticBean.OutputStreamOptions
    • Constructor Summary

      Constructors 
      Constructor Description
      EmptyLinesCheck()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void finishTree​(com.puppycrawl.tools.checkstyle.api.DetailAST root)  
      int[] getAcceptableTokens()  
      int[] getDefaultTokens()  
      int[] getRequiredTokens()  
      void visitToken​(com.puppycrawl.tools.checkstyle.api.DetailAST ast)  
      • Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

        beginTree, clearViolations, destroy, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, 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
    • Constructor Detail

      • EmptyLinesCheck

        public EmptyLinesCheck()
    • Method Detail

      • getDefaultTokens

        public int[] getDefaultTokens()
        Specified by:
        getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Specified by:
        getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • getRequiredTokens

        public int[] getRequiredTokens()
        Specified by:
        getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • visitToken

        public void visitToken​(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
        Overrides:
        visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck
      • finishTree

        public void finishTree​(com.puppycrawl.tools.checkstyle.api.DetailAST root)
        Overrides:
        finishTree in class com.puppycrawl.tools.checkstyle.api.AbstractCheck