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.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: "".

    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

      • message

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

        private Pattern format
        Define the RegExp for illegal pattern.
      • ignoreCase

        private boolean ignoreCase
        Control whether to ignore case when matching.
    • Method Detail

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

        public void setFormat​(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.