Package com.puppycrawl.tools.checkstyle.checks.header

Class AbstractHeaderCheck

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
All Implemented Interfaces:
Configurable, Contextualizable, ExternalResourceHolder, FileSetCheck
Direct Known Subclasses:
HeaderCheck, RegexpHeaderCheck
public abstract class AbstractHeaderCheck extends AbstractFileSetCheck implements ExternalResourceHolder
Abstract super class for header checks. Provides support for header and headerFile properties.

  • Constructor Details

    • AbstractHeaderCheck

      public AbstractHeaderCheck()

  • Method Details

    • postProcessHeaderLines

      protected abstract void postProcessHeaderLines()
      Hook method for post processing header lines. This implementation does nothing.

    • getHeaderLines

      protected List<String> getHeaderLines()
      Return the header lines to check against.
      Returns:
      the header lines to check against.

    • setCharset

      public void setCharset(String charset) throws UnsupportedEncodingException
      Setter to specify the character encoding to use when reading the headerFile.
      Parameters:
      charset - the charset to use for loading the header from a file
      Throws:
      UnsupportedEncodingException - if charset is unsupported

    • setHeaderFile

      public void setHeaderFile(URI uri) throws CheckstyleException
      Setter to specify the name of the file containing the required header..
      Parameters:
      uri - the uri of the header to load.
      Throws:
      CheckstyleException - if fileName is empty.

    • setHeader

      public void setHeader(String header)
      Set the header to check against. Individual lines in the header must be separated by '\n' characters.
      Parameters:
      header - header content to check against.
      Throws:
      IllegalArgumentException - if the header cannot be interpreted

    • finishLocalSetup

      protected final void finishLocalSetup() throws CheckstyleException
      Description copied from class: AutomaticBean
      Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

      The default implementation does nothing.

      Overrides:
      finishLocalSetup in class AbstractViolationReporter
      Throws:
      CheckstyleException - if there is a configuration error.

    • getExternalResourceLocations

      public Set<String> getExternalResourceLocations()
      Description copied from interface: ExternalResourceHolder
      Returns a set of external configuration resource locations which are used by the module. ATTENTION! If 'getExternalResourceLocations()' return null, there will be NullPointerException in Checker. Such behaviour will signal that your module (check or filter) is designed incorrectly. It make sense to return an empty set from 'getExternalResourceLocations()' only for composite modules like TreeWalker.
      Specified by:
      getExternalResourceLocations in interface ExternalResourceHolder
      Returns:
      a set of external configuration resource locations which are used by the module.