Package com.puppycrawl.tools.checkstyle.checks.regexp

Class RegexpOnFilenameCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
com.puppycrawl.tools.checkstyle.checks.regexp.RegexpOnFilenameCheck
All Implemented Interfaces:
Configurable, Contextualizable, FileSetCheck
public class RegexpOnFilenameCheck extends AbstractFileSetCheck
Checks that a specified pattern matches based on file and/or folder path. It can also be used to verify files match specific naming patterns not covered by other checks (Ex: properties, xml, etc.).

When customizing the check, the properties are applied in a specific order. The fileExtensions property first picks only files that match any of the specific extensions supplied. Once files are matched against the fileExtensions, the match property is then used in conjunction with the patterns to determine if the check is looking for a match or mismatch on those files. If the fileNamePattern is supplied, the matching is only applied to the fileNamePattern and not the folderPattern. If no fileNamePattern is supplied, then matching is applied to the folderPattern only and will result in all files in a folder to be reported on violations. If no folderPattern is supplied, then all folders that checkstyle finds are examined for violations. The ignoreFileNameExtensions property drops the file extension and applies the fileNamePattern only to the rest of file name. For example, if the file is named 'test.java' and this property is turned on, the pattern is only applied to 'test'.

If this check is configured with no properties, then the default behavior of this check is to report file names with spaces in them. When at least one pattern property is supplied, the entire check is under the user's control to allow them to fully customize the behavior.

It is recommended that if you create your own pattern, to also specify a custom violation message. This allows the violation message printed to be clear what the violation is, especially if multiple RegexpOnFilename checks are used. Argument 0 for the message populates the check's folderPattern. Argument 1 for the message populates the check's fileNamePattern. The file name is not passed as an argument since it is part of CheckStyle's default violation messages.

  • Property fileExtensions - Specify the file extensions of the files to process. Type is java.lang.String[]. Default value is "".
  • Property fileNamePattern - Specify the regular expression to match the file name against. Type is java.util.regex.Pattern. Default value is null.
  • Property folderPattern - Specify the regular expression to match the folder path against. Type is java.util.regex.Pattern. Default value is null.
  • Property ignoreFileNameExtensions - Control whether to ignore the file extension for the file name match. Type is boolean. Default value is false.
  • Property match - Control whether to look for a match or mismatch on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern. Type is boolean. Default value is true.

Parent is com.puppycrawl.tools.checkstyle.Checker

Violation Message Keys:

  • regexp.filename.match
  • regexp.filename.mismatch
Since:
6.15

  • Field Details

    • MSG_MATCH

      public static final String MSG_MATCH
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • MSG_MISMATCH

      public static final String MSG_MISMATCH
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • folderPattern

      private Pattern folderPattern
      Specify the regular expression to match the folder path against.

    • fileNamePattern

      private Pattern fileNamePattern
      Specify the regular expression to match the file name against.

    • match

      private boolean match
      Control whether to look for a match or mismatch on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern.

    • ignoreFileNameExtensions

      private boolean ignoreFileNameExtensions
      Control whether to ignore the file extension for the file name match.

  • Constructor Details

  • Method Details

    • setFolderPattern

      public void setFolderPattern(Pattern folderPattern)
      Setter to specify the regular expression to match the folder path against.
      Parameters:
      folderPattern - format of folder.
      Since:
      6.15

    • setFileNamePattern

      public void setFileNamePattern(Pattern fileNamePattern)
      Setter to specify the regular expression to match the file name against.
      Parameters:
      fileNamePattern - format of file.
      Since:
      6.15

    • setMatch

      public void setMatch(boolean match)
      Setter to control whether to look for a match or mismatch on the file name, if the fileNamePattern is supplied, otherwise it is applied on the folderPattern.
      Parameters:
      match - check's option for matching file names.
      Since:
      6.15

    • setIgnoreFileNameExtensions

      public void setIgnoreFileNameExtensions(boolean ignoreFileNameExtensions)
      Setter to control whether to ignore the file extension for the file name match.
      Parameters:
      ignoreFileNameExtensions - check's option for ignoring file extension.
      Since:
      6.15

    • init

      public void init()
      Description copied from interface: FileSetCheck
      Initialise the instance. This is the time to verify that everything required to perform its job.
      Specified by:
      init in interface FileSetCheck
      Overrides:
      init in class AbstractFileSetCheck

    • processFiltered

      protected void processFiltered(File file, FileText fileText) throws CheckstyleException
      Description copied from class: AbstractFileSetCheck
      Called to process a file that matches the specified file extensions.
      Specified by:
      processFiltered in class AbstractFileSetCheck
      Parameters:
      file - the file to be processed
      fileText - the contents of the file.
      Throws:
      CheckstyleException - if error condition within Checkstyle occurs.

    • getFileName

      private String getFileName(File file)
      Retrieves the file name from the given file.
      Parameters:
      file - Input file to examine.
      Returns:
      The file name.

    • getFolderPath

      private static String getFolderPath(File file) throws CheckstyleException
      Retrieves the folder path from the given file.
      Parameters:
      file - Input file to examine.
      Returns:
      The folder path.
      Throws:
      CheckstyleException - if there is an error getting the canonical path of the file.

    • isMatchFolder

      private boolean isMatchFolder(String folderPath)
      Checks if the given folderPath matches the specified folderPattern.
      Parameters:
      folderPath - Input folder path to examine.
      Returns:
      true if they do match.

    • isMatchFile

      private boolean isMatchFile(String fileName)
      Checks if the given fileName matches the specified fileNamePattern.
      Parameters:
      fileName - Input file name to examine.
      Returns:
      true if they do match.

    • log

      private void log()
      Logs the violations for the check.

    • getStringOrDefault

      private static String getStringOrDefault(Pattern pattern, String defaultString)
      Retrieves the String form of the pattern or defaultString if null.
      Parameters:
      pattern - The pattern to convert.
      defaultString - The result to use if pattern is null.
      Returns:
      The String form of the pattern.