Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
LocalVariableNameCheck |
|
| 1.6666666666666667;1.667 |
1 | //////////////////////////////////////////////////////////////////////////////// | |
2 | // checkstyle: Checks Java source code for adherence to a set of rules. | |
3 | // Copyright (C) 2001-2014 Oliver Burn | |
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 | package com.puppycrawl.tools.checkstyle.checks.naming; | |
20 | ||
21 | import com.puppycrawl.tools.checkstyle.api.DetailAST; | |
22 | import com.puppycrawl.tools.checkstyle.api.ScopeUtils; | |
23 | import com.puppycrawl.tools.checkstyle.api.TokenTypes; | |
24 | ||
25 | /** | |
26 | * <p> | |
27 | * Checks that local, non-final variable names conform to a format specified | |
28 | * by the format property. A catch parameter is considered to be | |
29 | * a local variable. The format is a | |
30 | * {@link java.util.regex.Pattern regular expression} | |
31 | * and defaults to | |
32 | * <strong>^[a-z][a-zA-Z0-9]*$</strong>. | |
33 | * </p> | |
34 | * <p> | |
35 | * An example of how to configure the check is: | |
36 | * </p> | |
37 | * <pre> | |
38 | * <module name="LocalVariableName"/> | |
39 | * </pre> | |
40 | * <p> | |
41 | * An example of how to configure the check for names that begin with a lower | |
42 | * case letter, followed by letters, digits, and underscores is: | |
43 | * </p> | |
44 | * <pre> | |
45 | * <module name="LocalVariableName"> | |
46 | * <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> | |
47 | * </module> | |
48 | * </pre> | |
49 | * @author Rick Giles | |
50 | * @version 1.0 | |
51 | */ | |
52 | public class LocalVariableNameCheck | |
53 | extends AbstractNameCheck | |
54 | { | |
55 | /** Creates a new <code>LocalVariableNameCheck</code> instance. */ | |
56 | public LocalVariableNameCheck() | |
57 | { | |
58 | 3 | super("^[a-z][a-zA-Z0-9]*$"); |
59 | 3 | } |
60 | ||
61 | @Override | |
62 | public int[] getDefaultTokens() | |
63 | { | |
64 | 3 | return new int[] { |
65 | TokenTypes.VARIABLE_DEF, | |
66 | TokenTypes.PARAMETER_DEF, | |
67 | }; | |
68 | } | |
69 | ||
70 | @Override | |
71 | protected final boolean mustCheckName(DetailAST aAST) | |
72 | { | |
73 | 56 | final DetailAST modifiersAST = |
74 | aAST.findFirstToken(TokenTypes.MODIFIERS); | |
75 | 56 | final boolean isFinal = (modifiersAST != null) |
76 | && modifiersAST.branchContains(TokenTypes.FINAL); | |
77 | 56 | return (!isFinal && ScopeUtils.isLocalVariableDef(aAST)); |
78 | } | |
79 | } |