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