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

Class 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.lang.String. Validation 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: empty.

    To configure the check to forbid String literals containing "a href": 

     <module name="IllegalTokenText">
   <property name="tokens" value="STRING_LITERAL"/>
   <property name="format" value="a href"/>
 </module>

    Example:

     public void myTest() {
     String test = "a href"; // violation
     String test2 = "A href"; // OK, case is sensitive
 }

    To configure the check to forbid String literals containing "a href" for the ignoreCase mode: 

     <module name="IllegalTokenText">
   <property name="tokens" value="STRING_LITERAL"/>
   <property name="format" value="a href"/>
   <property name="ignoreCase" value="true"/>
 </module>

    Example:

     public void myTest() {
     String test = "a href"; // violation
     String test2 = "A href"; // violation, case is ignored
 }

    To configure the check to forbid string literal text blocks containing """: 

     <module name="IllegalTokenText">
   <property name="tokens" value="TEXT_BLOCK_CONTENT"/>
   <property name="format" value='"'/>
 </module>

    Example:

     public void myTest() {
     final String quote = """
                \""""; // violation
 }

    To configure the check to forbid leading zeros in an integer literal, other than zero and a hex literal: 

     <module name="IllegalTokenText">
   <property name="tokens" value="NUM_INT,NUM_LONG"/>
   <property name="format" value="^0[^lx]"/>
   <property name="ignoreCase" value="true"/>
 </module>

    Example:

     public void myTest() {
     int test1 = 0; // OK
     int test2 = 0x111; // OK
     int test3 = 0X111; // OK, case is ignored
     int test4 = 010; // violation
     long test5 = 0L; // OK
     long test6 = 010L; // violation
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • illegal.token.text
    Since:
    3.2

    • Field Detail

      • MSG_KEY

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

    • Constructor Detail

      • IllegalTokenTextCheck

        public IllegalTokenTextCheck()

    • Method Detail

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

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

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

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

      • setMessage

        public void setMessage​(java.lang.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.

      • setFormat

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

      • setIgnoreCase

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