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

Class IllegalTokenCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class IllegalTokenCheck
extends AbstractCheck

    Checks for illegal tokens. By default labels are prohibited.

    Rationale: Certain language features can harm readability, lead to confusion or are not obvious to novice developers. Other features may be discouraged in certain frameworks, such as not having native methods in Enterprise JavaBeans components.

    • Property tokens - tokens to check Type is anyTokenTypesSet. Default value is LABELED_STAT.

    To configure the check: 

     <module name="IllegalToken"/>

    Example:

     public void myTest() {
     outer: // violation
     for (int i = 0; i < 5; i++) {
         if (i == 1) {
             break outer;
         }
     }
 }

    To configure the check to report violation on token LITERAL_NATIVE: 

     <module name="IllegalToken">
   <property name="tokens" value="LITERAL_NATIVE"/>
 </module>

    Example:

     public native void myTest(); // violation

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

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

      • IllegalTokenCheck

        public IllegalTokenCheck()

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