View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.naming;
21  
22  import com.puppycrawl.tools.checkstyle.StatelessCheck;
23  import com.puppycrawl.tools.checkstyle.api.DetailAST;
24  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
25  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
26  
27  /**
28   * <p>
29   * Checks identifiers with a pattern for a set of illegal names, such as those
30   * that are restricted or contextual keywords. Examples include "yield", "record", "_", and
31   * "var". Please read more at
32   * <a href="https://docs.oracle.com/javase/specs/jls/se14/html/jls-3.html#jls-3.9">
33   * Java Language Specification</a> to get to know more about restricted keywords. Since this
34   * check uses a pattern to specify valid identifiers, users can also prohibit the usage
35   * of certain symbols, such as "$", or any non-ascii character.
36   * </p>
37   * <ul>
38   * <li>
39   * Property {@code format} - Sets the pattern to match valid identifiers.
40   * Type is {@code java.util.regex.Pattern}.
41   * Default value is {@code "(?i)^(?!(record|yield|var|permits|sealed|_)$).+$"}.
42   * </li>
43   * <li>
44   * Property {@code tokens} - tokens to check
45   * Type is {@code java.lang.String[]}.
46   * Validation type is {@code tokenSet}.
47   * Default value is:
48   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">
49   * CLASS_DEF</a>,
50   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">
51   * INTERFACE_DEF</a>,
52   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">
53   * ENUM_DEF</a>,
54   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF">
55   * ANNOTATION_DEF</a>,
56   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF">
57   * ANNOTATION_FIELD_DEF</a>,
58   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PARAMETER_DEF">
59   * PARAMETER_DEF</a>,
60   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">
61   * VARIABLE_DEF</a>,
62   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
63   * METHOD_DEF</a>,
64   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">
65   * ENUM_CONSTANT_DEF</a>,
66   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PATTERN_VARIABLE_DEF">
67   * PATTERN_VARIABLE_DEF</a>,
68   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF">
69   * RECORD_DEF</a>,
70   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_COMPONENT_DEF">
71   * RECORD_COMPONENT_DEF</a>,
72   * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LAMBDA">
73   * LAMBDA</a>.
74   * </li>
75   * </ul>
76   * <p>
77   * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
78   * </p>
79   * <p>
80   * Violation Message Keys:
81   * </p>
82   * <ul>
83   * <li>
84   * {@code name.invalidPattern}
85   * </li>
86   * </ul>
87   *
88   * @since 8.36
89   */
90  @StatelessCheck
91  public class IllegalIdentifierNameCheck extends AbstractNameCheck {
92  
93      /**
94       * Creates a new {@code IllegalIdentifierNameCheck} instance.
95       */
96      public IllegalIdentifierNameCheck() {
97          super("(?i)^(?!(record|yield|var|permits|sealed|_)$).+$");
98      }
99  
100     @Override
101     public int[] getDefaultTokens() {
102         return getAcceptableTokens();
103     }
104 
105     @Override
106     public int[] getAcceptableTokens() {
107         return new int[] {
108             TokenTypes.CLASS_DEF,
109             TokenTypes.INTERFACE_DEF,
110             TokenTypes.ENUM_DEF,
111             TokenTypes.ANNOTATION_DEF,
112             TokenTypes.ANNOTATION_FIELD_DEF,
113             TokenTypes.PARAMETER_DEF,
114             TokenTypes.VARIABLE_DEF,
115             TokenTypes.METHOD_DEF,
116             TokenTypes.ENUM_CONSTANT_DEF,
117             TokenTypes.PATTERN_VARIABLE_DEF,
118             TokenTypes.RECORD_DEF,
119             TokenTypes.RECORD_COMPONENT_DEF,
120             TokenTypes.LAMBDA,
121         };
122     }
123 
124     @Override
125     public int[] getRequiredTokens() {
126         return CommonUtil.EMPTY_INT_ARRAY;
127     }
128 
129     @Override
130     protected boolean mustCheckName(DetailAST ast) {
131         return ast.findFirstToken(TokenTypes.IDENT) != null;
132     }
133 
134 }