Class Header

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck
com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
io.debezium.checkstyle.Header
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable, com.puppycrawl.tools.checkstyle.api.ExternalResourceHolder, com.puppycrawl.tools.checkstyle.api.FileSetCheck

public class Header extends com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck
  • 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 Set<String>
     
    private Pattern
     
    private String
     
    private final String
     
    private final int
     

    Fields inherited from class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck

    MSG_MISMATCH, MSG_MISSING
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
     
    protected void
    processFiltered(File aFile, com.puppycrawl.tools.checkstyle.api.FileText fileText)
     
    void
    setExcludedClasses(String excludedClasses)
     
    void
    setExcludedFilesRegex(String excludedFilePattern)
     
    void
    setHeaderFile(String aFileName)
     

    Methods inherited from class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck

    postProcessHeaderLines, setIgnoreLines

    Methods inherited from class com.puppycrawl.tools.checkstyle.checks.header.AbstractHeaderCheck

    finishLocalSetup, getExternalResourceLocations, getHeaderLines, setCharset, setHeader, setHeaderFile

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

    addViolations, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getTabWidth, getViolations, init, log, log, process, setFileContents, setFileExtensions, setMessageDispatcher, setTabWidth

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

    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

    Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable

    configure

    Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable

    contextualize
  • Field Details

    • excludedFileSet

      private Set<String> excludedFileSet
    • excludedFilesRegex

      private String excludedFilesRegex
    • excludedFilesPattern

      private Pattern excludedFilesPattern
    • workingDirPath

      private final String workingDirPath
    • workingDirPathLength

      private final int workingDirPathLength
  • Constructor Details

    • Header

      public Header()
  • Method Details

    • setExcludedFilesRegex

      public void setExcludedFilesRegex(String excludedFilePattern)
    • setExcludedClasses

      public void setExcludedClasses(String excludedClasses)
    • setHeaderFile

      public void setHeaderFile(String aFileName)
    • isExcluded

      protected boolean isExcluded(File file)
    • processFiltered

      protected void processFiltered(File aFile, com.puppycrawl.tools.checkstyle.api.FileText fileText)
      Overrides:
      processFiltered in class com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck