Package com.qulice.checkstyle

Class EmptyLinesCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.qulice.checkstyle.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 not thread safe. It builds a list of line ranges by visiting each method definition and each anonymous inner type, keeps them in instance fields until finishTree() reports and clears them, so a single instance must not be shared between threads.

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()
    Default constructor.

  • Method Summary

    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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EmptyLinesCheck

      public EmptyLinesCheck()
      Default constructor.

  • Method Details

    • 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