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

Class RegexpCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.regexp.RegexpCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class RegexpCheck extends AbstractCheck
Checks that a specified pattern exists, exists less than a set number of times, or does not exist in the file.

This check combines all the functionality provided by RegexpHeader except supplying the regular expression from a file.

It differs from them in that it works in multiline mode. Its regular expression can span multiple lines and it checks this against the whole file at once. The others work in single-line mode. Their single or multiple regular expressions can only span one line. They check each of these against each line in the file in turn.

Note: Because of the different mode of operation there may be some changes in the regular expressions used to achieve a particular end.

In multiline mode...

  • ^ means the beginning of a line, as opposed to beginning of the input.
  • For beginning of the input use \A.
  • $ means the end of a line, as opposed to the end of the input.
  • For end of input use \Z.
  • Each line in the file is terminated with a line feed character.

Note: Not all regular expression engines are created equal. Some provide extra functions that others do not and some elements of the syntax may vary. This check makes use of the java.util.regex package; please check its documentation for details of how to construct a regular expression to achieve a particular goal.

Note: When entering a regular expression as a parameter in the XML config file you must also take into account the XML rules. e.g. if you want to match a < symbol you need to enter &lt;. The regular expression should be entered on one line.

Note: To search for parentheses () in a regular expression you must escape them like \(\). This is required by the regexp engine, otherwise it will think they are special instruction characters.

Note: To search for things that mean something in XML, like < you need to escape them like &lt;. This is required so the XML parser does not act on them, but instead passes the correct character to the regexp engine.

  • Property duplicateLimit - Control whether to check for duplicates of a required pattern, any negative value means no checking for duplicates, any positive value is used as the maximum number of allowed duplicates, if the limit is exceeded violations will be logged. Type is int. Default value is 0.
  • Property errorLimit - Specify the maximum number of violations before the check will abort. Type is int. Default value is 100.
  • Property format - Specify the pattern to match against. Type is java.util.regex.Pattern. Default value is "^$".
  • Property ignoreComments - Control whether to ignore matches found within comments. Type is boolean. Default value is false.
  • Property illegalPattern - Control whether the pattern is required or illegal. Type is boolean. Default value is false.
  • Property message - Specify message which is used to notify about violations, if empty then the default (hard-coded) message is used. Type is java.lang.String. Default value is null.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • duplicate.regexp
  • illegal.regexp
  • required.regexp
Since:
4.0

  • Field Details

  • Constructor Details

  • Method Details

    • setMessage

      public void setMessage(String message)
      Setter to specify message which is used to notify about violations, if empty then the default (hard-coded) message is used.
      Parameters:
      message - custom message which should be used in report.
      Since:
      4.0

    • setIgnoreComments

      public void setIgnoreComments(boolean ignoreComments)
      Setter to control whether to ignore matches found within comments.
      Parameters:
      ignoreComments - True if comments should be ignored.
      Since:
      4.0

    • setIllegalPattern

      public void setIllegalPattern(boolean illegalPattern)
      Setter to control whether the pattern is required or illegal.
      Parameters:
      illegalPattern - True if pattern is not allowed.
      Since:
      4.0

    • setErrorLimit

      public void setErrorLimit(int errorLimit)
      Setter to specify the maximum number of violations before the check will abort.
      Parameters:
      errorLimit - the number of errors to report.
      Since:
      4.0

    • setDuplicateLimit

      public void setDuplicateLimit(int duplicateLimit)
      Setter to control whether to check for duplicates of a required pattern, any negative value means no checking for duplicates, any positive value is used as the maximum number of allowed duplicates, if the limit is exceeded violations will be logged.
      Parameters:
      duplicateLimit - negative values mean no duplicate checking, any positive value is used as the limit.
      Since:
      4.0

    • setFormat

      public final void setFormat(Pattern pattern)
      Setter to specify the pattern to match against.
      Parameters:
      pattern - the new pattern
      Since:
      4.0

    • getDefaultTokens

      public int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
      Specified by:
      getDefaultTokens in class AbstractCheck
      Returns:
      the default tokens
      See Also:

    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Description copied from class: AbstractCheck
      The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:

    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:

    • beginTree

      public void beginTree(DetailAST rootAST)
      Description copied from class: AbstractCheck
      Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
      Overrides:
      beginTree in class AbstractCheck
      Parameters:
      rootAST - the root of the tree

    • processRegexpMatches

      private void processRegexpMatches()
      Processes the regexp matches and logs the number of errors in the file.

    • isIgnore

      private boolean isIgnore(int startLine, FileText text, LineColumn start, Matcher matcher)
      Detect ignore situation.
      Parameters:
      startLine - position of line
      text - file text
      start - line column
      matcher - The matcher
      Returns:
      true is that need to be ignored

    • logMessage

      private void logMessage(int lineNumber, int errorCount)
      Displays the right message.
      Parameters:
      lineNumber - the line number the message relates to.
      errorCount - number of errors in the file.

    • getMessage

      private String getMessage(int errorCount)
      Provide right message.
      Parameters:
      errorCount - number of errors in the file.
      Returns:
      message for violation.