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

Class RegexpSinglelineJavaCheck

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.RegexpSinglelineJavaCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class RegexpSinglelineJavaCheck extends AbstractCheck
Checks that a specified pattern matches a single-line in Java files.

This class is variation on RegexpSingleline for detecting single-lines that match a supplied regular expression in Java files. It supports suppressing matches in Java comments.

  • Property format - Specify the format of the regular expression to match. Type is java.util.regex.Pattern. Default value is "$.".
  • Property ignoreCase - Control whether to ignore case when searching. Type is boolean. Default value is false.
  • Property ignoreComments - Control whether to ignore text in comments when searching. Type is boolean. Default value is false.
  • Property maximum - Specify the maximum number of matches required in each file. Type is int. Default value is 0.
  • Property message - Specify the message which is used to notify about violations, if empty then default (hard-coded) message is used. Type is java.lang.String. Default value is null.
  • Property minimum - Specify the minimum number of matches required in each file. Type is int. Default value is 0.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • regexp.exceeded
  • regexp.minimum
Since:
6.0

  • Field Details

    • format

      private String format
      Specify the format of the regular expression to match.

    • message

      private String message
      Specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.

    • minimum

      private int minimum
      Specify the minimum number of matches required in each file.

    • maximum

      private int maximum
      Specify the maximum number of matches required in each file.

    • ignoreCase

      private boolean ignoreCase
      Control whether to ignore case when searching.

    • ignoreComments

      private boolean ignoreComments
      Control whether to ignore text in comments when searching.

  • Constructor Details

  • Method Details

    • 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

    • setFormat

      public void setFormat(String format)
      Setter to specify the format of the regular expression to match.
      Parameters:
      format - the format of the regular expression to match.
      Since:
      5.0

    • setMessage

      public void setMessage(String message)
      Setter to specify the message which is used to notify about violations, if empty then default (hard-coded) message is used.
      Parameters:
      message - the message to report for a match.
      Since:
      6.0

    • setMinimum

      public void setMinimum(int minimum)
      Setter to specify the minimum number of matches required in each file.
      Parameters:
      minimum - the minimum number of matches required in each file.
      Since:
      5.0

    • setMaximum

      public void setMaximum(int maximum)
      Setter to specify the maximum number of matches required in each file.
      Parameters:
      maximum - the maximum number of matches required in each file.
      Since:
      5.0

    • setIgnoreCase

      public void setIgnoreCase(boolean ignoreCase)
      Setter to control whether to ignore case when searching.
      Parameters:
      ignoreCase - whether to ignore case when searching.
      Since:
      5.0

    • setIgnoreComments

      public void setIgnoreComments(boolean ignore)
      Setter to control whether to ignore text in comments when searching.
      Parameters:
      ignore - whether to ignore text in comments when searching.
      Since:
      5.0