Class 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
    • Constructor Summary

      Constructors 
      Constructor Description
      Header()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean isExcluded​(File file)  
      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

        addMessages, beginProcessing, destroy, finishProcessing, fireErrors, getFileContents, getFileExtensions, getMessageDispatcher, getMessages, getTabWidth, 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 interface com.puppycrawl.tools.checkstyle.api.Configurable

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

        contextualize
    • Field Detail

      • excludedFileSet

        private Set<String> excludedFileSet
      • excludedFilesRegex

        private String excludedFilesRegex
      • excludedFilesPattern

        private Pattern excludedFilesPattern
      • workingDirPath

        private final String workingDirPath
      • workingDirPathLength

        private final int workingDirPathLength
    • Constructor Detail

      • Header

        public Header()
    • Method Detail

      • 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