View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.api.DetailAST;
23  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24  import com.puppycrawl.tools.checkstyle.utils.ScopeUtil;
25  
26  /**
27   * <div>
28   * Checks that instance variable names conform to a specified pattern.
29   * </div>
30   * <ul>
31   * <li>
32   * Property {@code applyToPackage} - Control if check should apply to package-private members.
33   * Type is {@code boolean}.
34   * Default value is {@code true}.
35   * Since version 3.4
36   * </li>
37   * <li>
38   * Property {@code applyToPrivate} - Control if check should apply to private members.
39   * Type is {@code boolean}.
40   * Default value is {@code true}.
41   * Since version 3.4
42   * </li>
43   * <li>
44   * Property {@code applyToProtected} - Control if check should apply to protected members.
45   * Type is {@code boolean}.
46   * Default value is {@code true}.
47   * Since version 3.4
48   * </li>
49   * <li>
50   * Property {@code applyToPublic} - Control if check should apply to public members.
51   * Type is {@code boolean}.
52   * Default value is {@code true}.
53   * Since version 3.4
54   * </li>
55   * <li>
56   * Property {@code format} - Sets the pattern to match valid identifiers.
57   * Type is {@code java.util.regex.Pattern}.
58   * Default value is {@code "^[a-z][a-zA-Z0-9]*$"}.
59   * </li>
60   * </ul>
61   *
62   * <p>
63   * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
64   * </p>
65   *
66   * <p>
67   * Violation Message Keys:
68   * </p>
69   * <ul>
70   * <li>
71   * {@code name.invalidPattern}
72   * </li>
73   * </ul>
74   *
75   * @since 3.0
76   */
77  public class MemberNameCheck
78      extends AbstractAccessControlNameCheck {
79  
80      /** Creates a new {@code MemberNameCheck} instance. */
81      public MemberNameCheck() {
82          super("^[a-z][a-zA-Z0-9]*$");
83      }
84  
85      @Override
86      public int[] getDefaultTokens() {
87          return getRequiredTokens();
88      }
89  
90      @Override
91      public int[] getAcceptableTokens() {
92          return getRequiredTokens();
93      }
94  
95      @Override
96      public int[] getRequiredTokens() {
97          return new int[] {TokenTypes.VARIABLE_DEF};
98      }
99  
100     @Override
101     protected final boolean mustCheckName(DetailAST ast) {
102         final DetailAST modifiersAST =
103             ast.findFirstToken(TokenTypes.MODIFIERS);
104         final boolean isStatic = modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC) != null;
105 
106         return !isStatic && !ScopeUtil.isInInterfaceOrAnnotationBlock(ast)
107             && !ScopeUtil.isLocalVariableDef(ast)
108                 && shouldCheckInScope(modifiersAST);
109     }
110 
111 }