Package io.debezium.checkstyle

Class IllegalImport

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
io.debezium.checkstyle.IllegalImport
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
public class IllegalImport extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
A simple CheckStyle checker to verify specific import statements are not being used.
Author:
Sanne Grinovero

  • Nested Class Summary

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

    com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private String
    message
     
    private final HashSet<String>
    notAllowedImports
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    IllegalImport()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private String
    buildError(String importStatement)
     
    int[]
    getAcceptableTokens()
     
    int[]
    getDefaultTokens()
     
    int[]
    getRequiredTokens()
     
    private boolean
    isIllegalImport(String importString)
     
    void
    setIllegalClassnames(String[] importStatements)
    Set the list of illegal import statements.
    void
    setMessage(String message)
     
    void
    visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
     

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

    beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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.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 Details

    • notAllowedImports

      private final HashSet<String> notAllowedImports

    • message

      private String message

  • Constructor Details

    • IllegalImport

      public IllegalImport()

  • Method Details

    • setIllegalClassnames

      public void setIllegalClassnames(String[] importStatements)
      Set the list of illegal import statements.
      Parameters:
      importStatements - array of illegal packages

    • setMessage

      public void setMessage(String message)

    • 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 aAST)
      Overrides:
      visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • buildError

      private String buildError(String importStatement)

    • isIllegalImport

      private boolean isIllegalImport(String importString)