001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.checks.naming; 021 022import com.puppycrawl.tools.checkstyle.StatelessCheck; 023import com.puppycrawl.tools.checkstyle.api.DetailAST; 024import com.puppycrawl.tools.checkstyle.api.TokenTypes; 025import com.puppycrawl.tools.checkstyle.utils.CommonUtil; 026 027/** 028 * <p> 029 * Checks identifiers with a pattern for a set of illegal names, such as those 030 * that are restricted or contextual keywords. Examples include "yield", "record", "_", and 031 * "var". Please read more at 032 * <a href="https://docs.oracle.com/javase/specs/jls/se14/html/jls-3.html#jls-3.9"> 033 * Java Language Specification</a> to get to know more about restricted keywords. Since this 034 * check uses a pattern to specify valid identifiers, users can also prohibit the usage 035 * of certain symbols, such as "$", or any non-ascii character. 036 * </p> 037 * <ul> 038 * <li> 039 * Property {@code format} - Sets the pattern to match valid identifiers. 040 * Type is {@code java.util.regex.Pattern}. 041 * Default value is {@code "(?i)^(?!(record|yield|var|permits|sealed|_)$).+$"}. 042 * </li> 043 * <li> 044 * Property {@code tokens} - tokens to check 045 * Type is {@code java.lang.String[]}. 046 * Validation type is {@code tokenSet}. 047 * Default value is: 048 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF"> 049 * CLASS_DEF</a>, 050 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF"> 051 * INTERFACE_DEF</a>, 052 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF"> 053 * ENUM_DEF</a>, 054 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_DEF"> 055 * ANNOTATION_DEF</a>, 056 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ANNOTATION_FIELD_DEF"> 057 * ANNOTATION_FIELD_DEF</a>, 058 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PARAMETER_DEF"> 059 * PARAMETER_DEF</a>, 060 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF"> 061 * VARIABLE_DEF</a>, 062 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF"> 063 * METHOD_DEF</a>, 064 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF"> 065 * ENUM_CONSTANT_DEF</a>, 066 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PATTERN_VARIABLE_DEF"> 067 * PATTERN_VARIABLE_DEF</a>, 068 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF"> 069 * RECORD_DEF</a>, 070 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_COMPONENT_DEF"> 071 * RECORD_COMPONENT_DEF</a>, 072 * <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LAMBDA"> 073 * LAMBDA</a>. 074 * </li> 075 * </ul> 076 * <p> 077 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker} 078 * </p> 079 * <p> 080 * Violation Message Keys: 081 * </p> 082 * <ul> 083 * <li> 084 * {@code name.invalidPattern} 085 * </li> 086 * </ul> 087 * 088 * @since 8.36 089 */ 090@StatelessCheck 091public class IllegalIdentifierNameCheck extends AbstractNameCheck { 092 093 /** 094 * Creates a new {@code IllegalIdentifierNameCheck} instance. 095 */ 096 public IllegalIdentifierNameCheck() { 097 super("(?i)^(?!(record|yield|var|permits|sealed|_)$).+$"); 098 } 099 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}