1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
package com.puppycrawl.tools.checkstyle.checks.coding; |
20 | |
|
21 | |
import com.google.common.collect.Sets; |
22 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
23 | |
import com.puppycrawl.tools.checkstyle.api.FullIdent; |
24 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
25 | |
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck; |
26 | |
import com.puppycrawl.tools.checkstyle.checks.CheckUtils; |
27 | |
import java.util.Set; |
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
|
41 | |
|
42 | |
|
43 | |
public final class IllegalTypeCheck extends AbstractFormatCheck |
44 | |
{ |
45 | |
|
46 | |
private static final String DEFAULT_FORMAT = "^(.*[\\.])?Abstract.*$"; |
47 | |
|
48 | 1 | private static final String[] DEFAULT_LEGAL_ABSTRACT_NAMES = {}; |
49 | |
|
50 | 1 | private static final String[] DEFAULT_ILLEGAL_TYPES = { |
51 | |
"GregorianCalendar", |
52 | |
"Hashtable", |
53 | |
"HashSet", |
54 | |
"HashMap", |
55 | |
"ArrayList", |
56 | |
"LinkedList", |
57 | |
"LinkedHashMap", |
58 | |
"LinkedHashSet", |
59 | |
"TreeSet", |
60 | |
"TreeMap", |
61 | |
"Vector", |
62 | |
"java.util.GregorianCalendar", |
63 | |
"java.util.Hashtable", |
64 | |
"java.util.HashSet", |
65 | |
"java.util.HashMap", |
66 | |
"java.util.ArrayList", |
67 | |
"java.util.LinkedList", |
68 | |
"java.util.LinkedHashMap", |
69 | |
"java.util.LinkedHashSet", |
70 | |
"java.util.TreeSet", |
71 | |
"java.util.TreeMap", |
72 | |
"java.util.Vector", |
73 | |
}; |
74 | |
|
75 | |
|
76 | 1 | private static final String[] DEFAULT_IGNORED_METHOD_NAMES = { |
77 | |
"getInitialContext", |
78 | |
"getEnvironment", |
79 | |
}; |
80 | |
|
81 | |
|
82 | 4 | private final Set<String> mIllegalClassNames = Sets.newHashSet(); |
83 | |
|
84 | 4 | private final Set<String> mLegalAbstractClassNames = Sets.newHashSet(); |
85 | |
|
86 | 4 | private final Set<String> mIgnoredMethodNames = Sets.newHashSet(); |
87 | |
|
88 | |
|
89 | |
public IllegalTypeCheck() |
90 | |
{ |
91 | 4 | super(DEFAULT_FORMAT); |
92 | 4 | setIllegalClassNames(DEFAULT_ILLEGAL_TYPES); |
93 | 4 | setLegalAbstractClassNames(DEFAULT_LEGAL_ABSTRACT_NAMES); |
94 | 4 | setIgnoredMethodNames(DEFAULT_IGNORED_METHOD_NAMES); |
95 | 4 | } |
96 | |
|
97 | |
@Override |
98 | |
public int[] getDefaultTokens() |
99 | |
{ |
100 | 4 | return new int[] { |
101 | |
TokenTypes.VARIABLE_DEF, |
102 | |
TokenTypes.PARAMETER_DEF, |
103 | |
TokenTypes.METHOD_DEF, |
104 | |
}; |
105 | |
} |
106 | |
|
107 | |
@Override |
108 | |
public void visitToken(DetailAST aAST) |
109 | |
{ |
110 | 24 | switch (aAST.getType()) { |
111 | |
case TokenTypes.METHOD_DEF: |
112 | 8 | visitMethodDef(aAST); |
113 | 8 | break; |
114 | |
case TokenTypes.VARIABLE_DEF: |
115 | 16 | visitVariableDef(aAST); |
116 | 16 | break; |
117 | |
case TokenTypes.PARAMETER_DEF: |
118 | 0 | visitParameterDef(aAST); |
119 | 0 | break; |
120 | |
default: |
121 | 0 | throw new IllegalStateException(aAST.toString()); |
122 | |
} |
123 | 24 | } |
124 | |
|
125 | |
|
126 | |
|
127 | |
|
128 | |
|
129 | |
private void visitMethodDef(DetailAST aAST) |
130 | |
{ |
131 | 8 | if (isCheckedMethod(aAST)) { |
132 | 7 | checkClassName(aAST); |
133 | |
} |
134 | 8 | } |
135 | |
|
136 | |
|
137 | |
|
138 | |
|
139 | |
|
140 | |
private void visitParameterDef(DetailAST aAST) |
141 | |
{ |
142 | 0 | final DetailAST grandParentAST = aAST.getParent().getParent(); |
143 | |
|
144 | 0 | if ((grandParentAST.getType() == TokenTypes.METHOD_DEF) |
145 | |
&& isCheckedMethod(grandParentAST)) |
146 | |
{ |
147 | 0 | checkClassName(aAST); |
148 | |
} |
149 | 0 | } |
150 | |
|
151 | |
|
152 | |
|
153 | |
|
154 | |
|
155 | |
private void visitVariableDef(DetailAST aAST) |
156 | |
{ |
157 | 16 | checkClassName(aAST); |
158 | 16 | } |
159 | |
|
160 | |
|
161 | |
|
162 | |
|
163 | |
|
164 | |
private void checkClassName(DetailAST aAST) |
165 | |
{ |
166 | 23 | final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE); |
167 | 23 | final FullIdent ident = CheckUtils.createFullType(type); |
168 | |
|
169 | 23 | if (isMatchingClassName(ident.getText())) { |
170 | 12 | log(ident.getLineNo(), ident.getColumnNo(), |
171 | |
"illegal.type", ident.getText()); |
172 | |
} |
173 | 23 | } |
174 | |
|
175 | |
|
176 | |
|
177 | |
|
178 | |
|
179 | |
|
180 | |
private boolean isMatchingClassName(String aClassName) |
181 | |
{ |
182 | 23 | return mIllegalClassNames.contains(aClassName) |
183 | |
|| (!mLegalAbstractClassNames.contains(aClassName) |
184 | |
&& getRegexp().matcher(aClassName).find()); |
185 | |
} |
186 | |
|
187 | |
|
188 | |
|
189 | |
|
190 | |
|
191 | |
private boolean isCheckedMethod(DetailAST aAST) |
192 | |
{ |
193 | 8 | final String methodName = |
194 | |
aAST.findFirstToken(TokenTypes.IDENT).getText(); |
195 | 8 | return !mIgnoredMethodNames.contains(methodName); |
196 | |
} |
197 | |
|
198 | |
|
199 | |
|
200 | |
|
201 | |
|
202 | |
public void setIllegalClassNames(String[] aClassNames) |
203 | |
{ |
204 | 4 | mIllegalClassNames.clear(); |
205 | 92 | for (String name : aClassNames) { |
206 | 88 | mIllegalClassNames.add(name); |
207 | 88 | final int lastDot = name.lastIndexOf("."); |
208 | 88 | if ((lastDot > 0) && (lastDot < (name.length() - 1))) { |
209 | 44 | final String shortName = |
210 | |
name.substring(name.lastIndexOf(".") + 1); |
211 | 44 | mIllegalClassNames.add(shortName); |
212 | |
} |
213 | |
} |
214 | 4 | } |
215 | |
|
216 | |
|
217 | |
|
218 | |
|
219 | |
|
220 | |
public String[] getIllegalClassNames() |
221 | |
{ |
222 | 0 | return mIllegalClassNames.toArray( |
223 | |
new String[mIllegalClassNames.size()]); |
224 | |
} |
225 | |
|
226 | |
|
227 | |
|
228 | |
|
229 | |
|
230 | |
public void setIgnoredMethodNames(String[] aMethodNames) |
231 | |
{ |
232 | 5 | mIgnoredMethodNames.clear(); |
233 | 14 | for (String element : aMethodNames) { |
234 | 9 | mIgnoredMethodNames.add(element); |
235 | |
} |
236 | 5 | } |
237 | |
|
238 | |
|
239 | |
|
240 | |
|
241 | |
|
242 | |
public String[] getIgnoredMethodNames() |
243 | |
{ |
244 | 0 | return mIgnoredMethodNames.toArray( |
245 | |
new String[mIgnoredMethodNames.size()]); |
246 | |
} |
247 | |
|
248 | |
|
249 | |
|
250 | |
|
251 | |
|
252 | |
public void setLegalAbstractClassNames(String[] aClassNames) |
253 | |
{ |
254 | 5 | mLegalAbstractClassNames.clear(); |
255 | 6 | for (String element : aClassNames) { |
256 | 1 | mLegalAbstractClassNames.add(element); |
257 | |
} |
258 | 5 | } |
259 | |
|
260 | |
|
261 | |
|
262 | |
|
263 | |
|
264 | |
public String[] getLegalAbstractClassNames() |
265 | |
{ |
266 | 0 | return mLegalAbstractClassNames.toArray( |
267 | |
new String[mLegalAbstractClassNames.size()]); |
268 | |
} |
269 | |
} |