Package com.puppycrawl.tools.checkstyle.checks.coding

Class IllegalTokenTextCheck

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.coding.IllegalTokenTextCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class IllegalTokenTextCheck extends AbstractCheck
Checks specified tokens text for matching an illegal pattern. By default, no tokens are specified.
  • Property format - Define the RegExp for illegal pattern. Type is java.util.regex.Pattern. Default value is "^$".
  • Property ignoreCase - Control whether to ignore case when matching. Type is boolean. Default value is false.
  • Property message - Define the message which is used to notify about violations; if empty then the default message is used. Type is java.lang.String. Default value is "".
  • Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: "".

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • illegal.token.text
Since:
3.2

  • Field Details

    • MSG_KEY

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

    • message

      private String message
      Define the message which is used to notify about violations; if empty then the default message is used.

    • formatString

      private String formatString
      The format string of the regexp.

    • format

      private Pattern format
      Define the RegExp for illegal pattern.

    • ignoreCase

      private boolean ignoreCase
      Control whether to ignore case when matching.

  • 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:

    • isCommentNodesRequired

      public boolean isCommentNodesRequired()
      Description copied from class: AbstractCheck
      Whether comment nodes are required or not.
      Overrides:
      isCommentNodesRequired in class AbstractCheck
      Returns:
      false as a default value.

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • setMessage

      public void setMessage(String message)
      Setter to define the message which is used to notify about violations; if empty then the default message is used.
      Parameters:
      message - custom message which should be used to report about violations.
      Since:
      3.2

    • setFormat

      public void setFormat(String format)
      Setter to define the RegExp for illegal pattern.
      Parameters:
      format - a String value
      Since:
      3.2

    • setIgnoreCase

      public void setIgnoreCase(boolean caseInsensitive)
      Setter to control whether to ignore case when matching.
      Parameters:
      caseInsensitive - true if the match is case-insensitive.
      Since:
      3.2

    • updateRegexp

      private void updateRegexp()
      Updates the format based on the values from formatString and ignoreCase.