1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package com.puppycrawl.tools.checkstyle.checks.naming;
21
22 import java.util.Arrays;
23 import java.util.Optional;
24
25 import com.puppycrawl.tools.checkstyle.api.DetailAST;
26 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
27 import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50 public class ParameterNameCheck extends AbstractNameCheck {
51
52
53
54
55 private boolean ignoreOverridden;
56
57
58 private AccessModifierOption[] accessModifiers = {
59 AccessModifierOption.PUBLIC,
60 AccessModifierOption.PROTECTED,
61 AccessModifierOption.PACKAGE,
62 AccessModifierOption.PRIVATE,
63 };
64
65
66
67
68 public ParameterNameCheck() {
69 super("^[a-z][a-zA-Z0-9]*$");
70 }
71
72
73
74
75
76
77
78 public void setIgnoreOverridden(boolean ignoreOverridden) {
79 this.ignoreOverridden = ignoreOverridden;
80 }
81
82
83
84
85
86
87
88 public void setAccessModifiers(AccessModifierOption... accessModifiers) {
89 this.accessModifiers =
90 Arrays.copyOf(accessModifiers, accessModifiers.length);
91 }
92
93 @Override
94 public int[] getDefaultTokens() {
95 return getRequiredTokens();
96 }
97
98 @Override
99 public int[] getAcceptableTokens() {
100 return getRequiredTokens();
101 }
102
103 @Override
104 public int[] getRequiredTokens() {
105 return new int[] {TokenTypes.PARAMETER_DEF};
106 }
107
108 @Override
109 protected boolean mustCheckName(DetailAST ast) {
110 boolean checkName = true;
111 final DetailAST parent = ast.getParent();
112 if (ignoreOverridden && isOverriddenMethod(ast)
113 || parent.getType() == TokenTypes.LITERAL_CATCH
114 || parent.getParent().getType() == TokenTypes.LAMBDA
115 || CheckUtil.isReceiverParameter(ast)
116 || !matchAccessModifiers(
117 CheckUtil.getAccessModifierFromModifiersToken(parent.getParent()))) {
118 checkName = false;
119 }
120 return checkName;
121 }
122
123
124
125
126
127
128
129 private boolean matchAccessModifiers(final AccessModifierOption accessModifier) {
130 return Arrays.stream(accessModifiers)
131 .anyMatch(modifier -> modifier == accessModifier);
132 }
133
134
135
136
137
138
139
140 private static boolean isOverriddenMethod(DetailAST ast) {
141 boolean overridden = false;
142
143 final DetailAST parent = ast.getParent().getParent();
144 final Optional<DetailAST> annotation =
145 Optional.ofNullable(parent.getFirstChild().getFirstChild());
146
147 if (annotation.isPresent()) {
148 final Optional<DetailAST> overrideToken =
149 Optional.ofNullable(annotation.orElseThrow().findFirstToken(TokenTypes.IDENT));
150 if (overrideToken.isPresent()
151 && "Override".equals(overrideToken.orElseThrow().getText())) {
152 overridden = true;
153 }
154 }
155 return overridden;
156 }
157
158 }