1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
package com.puppycrawl.tools.checkstyle.api; |
20 | |
|
21 | |
import com.google.common.collect.ImmutableMap; |
22 | |
import java.util.Map; |
23 | |
|
24 | |
|
25 | |
|
26 | |
|
27 | |
|
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
|
41 | |
|
42 | |
|
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
|
48 | |
|
49 | |
|
50 | |
|
51 | |
|
52 | |
|
53 | |
|
54 | |
|
55 | |
|
56 | |
|
57 | |
|
58 | |
|
59 | |
|
60 | 21 | public enum JavadocTagInfo |
61 | |
{ |
62 | |
|
63 | |
|
64 | |
|
65 | 1 | AUTHOR("@author", "author", Type.BLOCK, true, true) |
66 | |
{ |
67 | |
|
68 | |
@Override |
69 | |
public boolean isValidOn(final DetailAST aAst) |
70 | |
{ |
71 | 0 | final int type = aAst.getType(); |
72 | 0 | return type == TokenTypes.PACKAGE_DEF |
73 | |
|| type == TokenTypes.CLASS_DEF |
74 | |
|| type == TokenTypes.INTERFACE_DEF |
75 | |
|| type == TokenTypes.ENUM_DEF |
76 | |
|| type == TokenTypes.ANNOTATION_DEF; |
77 | |
} |
78 | |
}, |
79 | |
|
80 | |
|
81 | |
|
82 | |
|
83 | 1 | CODE("{@code}", "code", Type.INLINE, true, true) |
84 | |
{ |
85 | |
|
86 | |
@Override |
87 | |
public boolean isValidOn(final DetailAST aAst) |
88 | |
{ |
89 | 0 | final int type = aAst.getType(); |
90 | 0 | return type == TokenTypes.PACKAGE_DEF |
91 | |
|| type == TokenTypes.CLASS_DEF |
92 | |
|| type == TokenTypes.INTERFACE_DEF |
93 | |
|| type == TokenTypes.ENUM_DEF |
94 | |
|| type == TokenTypes.ANNOTATION_DEF |
95 | |
|| type == TokenTypes.METHOD_DEF |
96 | |
|| type == TokenTypes.CTOR_DEF |
97 | |
|| (type == TokenTypes.VARIABLE_DEF |
98 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
99 | |
} |
100 | |
}, |
101 | |
|
102 | |
|
103 | |
|
104 | |
|
105 | 1 | DOC_ROOT("{@docRoot}", "docRoot", Type.INLINE, true, true) |
106 | |
{ |
107 | |
|
108 | |
@Override |
109 | |
public boolean isValidOn(final DetailAST aAst) |
110 | |
{ |
111 | 0 | final int type = aAst.getType(); |
112 | 0 | return type == TokenTypes.PACKAGE_DEF |
113 | |
|| type == TokenTypes.CLASS_DEF |
114 | |
|| type == TokenTypes.INTERFACE_DEF |
115 | |
|| type == TokenTypes.ENUM_DEF |
116 | |
|| type == TokenTypes.ANNOTATION_DEF |
117 | |
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF |
118 | |
|| (type == TokenTypes.VARIABLE_DEF |
119 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
120 | |
} |
121 | |
}, |
122 | |
|
123 | |
|
124 | |
|
125 | |
|
126 | 1 | DEPRECATED("@deprecated", "deprecated", Type.BLOCK, false, false) |
127 | |
{ |
128 | |
|
129 | |
@Override |
130 | |
public boolean isValidOn(final DetailAST aAst) |
131 | |
{ |
132 | 0 | final int type = aAst.getType(); |
133 | 0 | return type == TokenTypes.CLASS_DEF |
134 | |
|| type == TokenTypes.INTERFACE_DEF |
135 | |
|| type == TokenTypes.ENUM_DEF |
136 | |
|| type == TokenTypes.ANNOTATION_DEF |
137 | |
|| type == TokenTypes.METHOD_DEF |
138 | |
|| type == TokenTypes.CTOR_DEF |
139 | |
|| type == TokenTypes.ENUM_CONSTANT_DEF |
140 | |
|| type == TokenTypes.ANNOTATION_FIELD_DEF |
141 | |
|| (type == TokenTypes.VARIABLE_DEF |
142 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
143 | |
} |
144 | |
}, |
145 | |
|
146 | |
|
147 | |
|
148 | |
|
149 | 1 | EXCEPTION("@exception", "exception", Type.BLOCK, false, false) |
150 | |
{ |
151 | |
|
152 | |
@Override |
153 | |
public boolean isValidOn(final DetailAST aAst) |
154 | |
{ |
155 | 0 | final int type = aAst.getType(); |
156 | 0 | return type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF; |
157 | |
} |
158 | |
}, |
159 | |
|
160 | |
|
161 | |
|
162 | |
|
163 | 1 | INHERIT_DOC("{@inheritDoc}", "inheritDoc", Type.INLINE, false, false) |
164 | |
{ |
165 | |
|
166 | |
@Override |
167 | |
public boolean isValidOn(final DetailAST aAst) |
168 | |
{ |
169 | 83 | final int type = aAst.getType(); |
170 | |
|
171 | 83 | return type == TokenTypes.METHOD_DEF |
172 | |
&& !aAst.branchContains(TokenTypes.LITERAL_STATIC) |
173 | |
&& ScopeUtils.getScopeFromMods(aAst |
174 | |
.findFirstToken(TokenTypes.MODIFIERS)) != Scope.PRIVATE; |
175 | |
} |
176 | |
}, |
177 | |
|
178 | |
|
179 | |
|
180 | |
|
181 | 1 | LINK("{@link}", "link", Type.INLINE, true, true) |
182 | |
{ |
183 | |
|
184 | |
@Override |
185 | |
public boolean isValidOn(final DetailAST aAst) |
186 | |
{ |
187 | 0 | final int type = aAst.getType(); |
188 | 0 | return type == TokenTypes.PACKAGE_DEF |
189 | |
|| type == TokenTypes.CLASS_DEF |
190 | |
|| type == TokenTypes.INTERFACE_DEF |
191 | |
|| type == TokenTypes.ENUM_DEF |
192 | |
|| type == TokenTypes.ANNOTATION_DEF |
193 | |
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF |
194 | |
|| (type == TokenTypes.VARIABLE_DEF |
195 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
196 | |
} |
197 | |
}, |
198 | |
|
199 | |
|
200 | |
|
201 | |
|
202 | 1 | LINKPLAIN("{@linkplain}", "linkplain", Type.INLINE, true, true) |
203 | |
{ |
204 | |
|
205 | |
@Override |
206 | |
public boolean isValidOn(final DetailAST aAst) |
207 | |
{ |
208 | 0 | final int type = aAst.getType(); |
209 | 0 | return type == TokenTypes.PACKAGE_DEF |
210 | |
|| type == TokenTypes.CLASS_DEF |
211 | |
|| type == TokenTypes.INTERFACE_DEF |
212 | |
|| type == TokenTypes.ENUM_DEF |
213 | |
|| type == TokenTypes.ANNOTATION_DEF |
214 | |
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF |
215 | |
|| (type == TokenTypes.VARIABLE_DEF |
216 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
217 | |
} |
218 | |
}, |
219 | |
|
220 | |
|
221 | |
|
222 | |
|
223 | 1 | LITERAL("{@literal}", "literal", Type.INLINE, true, true) |
224 | |
{ |
225 | |
|
226 | |
@Override |
227 | |
public boolean isValidOn(final DetailAST aAst) |
228 | |
{ |
229 | 0 | final int type = aAst.getType(); |
230 | 0 | return type == TokenTypes.PACKAGE_DEF |
231 | |
|| type == TokenTypes.CLASS_DEF |
232 | |
|| type == TokenTypes.INTERFACE_DEF |
233 | |
|| type == TokenTypes.ENUM_DEF |
234 | |
|| type == TokenTypes.ANNOTATION_DEF |
235 | |
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF |
236 | |
|| (type == TokenTypes.VARIABLE_DEF |
237 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
238 | |
} |
239 | |
}, |
240 | |
|
241 | |
|
242 | |
|
243 | |
|
244 | 1 | PARAM("@param", "param", Type.BLOCK, false, false) |
245 | |
{ |
246 | |
|
247 | |
@Override |
248 | |
public boolean isValidOn(final DetailAST aAst) |
249 | |
{ |
250 | 0 | final int type = aAst.getType(); |
251 | 0 | return type == TokenTypes.CLASS_DEF |
252 | |
|| type == TokenTypes.INTERFACE_DEF |
253 | |
|| type == TokenTypes.METHOD_DEF |
254 | |
|| type == TokenTypes.CTOR_DEF; |
255 | |
} |
256 | |
}, |
257 | |
|
258 | |
|
259 | |
|
260 | |
|
261 | 1 | RETURN("@return", "return", Type.BLOCK, false, false) |
262 | |
{ |
263 | |
|
264 | |
@Override |
265 | |
public boolean isValidOn(final DetailAST aAst) |
266 | |
{ |
267 | 0 | final int type = aAst.getType(); |
268 | 0 | final DetailAST returnType = aAst.findFirstToken(TokenTypes.TYPE); |
269 | |
|
270 | 0 | return type == TokenTypes.METHOD_DEF |
271 | |
&& returnType.getFirstChild().getType() |
272 | |
!= TokenTypes.LITERAL_VOID; |
273 | |
|
274 | |
} |
275 | |
}, |
276 | |
|
277 | |
|
278 | |
|
279 | |
|
280 | 1 | SEE("@see", "see", Type.BLOCK, true, true) |
281 | |
{ |
282 | |
|
283 | |
@Override |
284 | |
public boolean isValidOn(final DetailAST aAst) |
285 | |
{ |
286 | 0 | final int type = aAst.getType(); |
287 | 0 | return type == TokenTypes.PACKAGE_DEF |
288 | |
|| type == TokenTypes.CLASS_DEF |
289 | |
|| type == TokenTypes.INTERFACE_DEF |
290 | |
|| type == TokenTypes.ENUM_DEF |
291 | |
|| type == TokenTypes.ANNOTATION_DEF |
292 | |
|| type == TokenTypes.METHOD_DEF |
293 | |
|| type == TokenTypes.CTOR_DEF |
294 | |
|| (type == TokenTypes.VARIABLE_DEF |
295 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
296 | |
} |
297 | |
}, |
298 | |
|
299 | |
|
300 | |
|
301 | |
|
302 | 1 | SERIAL("@serial", "serial", Type.BLOCK, true, false) |
303 | |
{ |
304 | |
|
305 | |
@Override |
306 | |
public boolean isValidOn(final DetailAST aAst) |
307 | |
{ |
308 | 0 | final int type = aAst.getType(); |
309 | |
|
310 | 0 | return type == TokenTypes.VARIABLE_DEF |
311 | |
&& !ScopeUtils.isLocalVariableDef(aAst); |
312 | |
} |
313 | |
}, |
314 | |
|
315 | |
|
316 | |
|
317 | |
|
318 | 1 | SERIAL_DATA("@serialData", "serialData", Type.BLOCK, false, false) |
319 | |
{ |
320 | |
|
321 | |
@Override |
322 | |
public boolean isValidOn(final DetailAST aAst) |
323 | |
{ |
324 | 0 | final int type = aAst.getType(); |
325 | 0 | final DetailAST methodNameAst = aAst |
326 | |
.findFirstToken(TokenTypes.IDENT); |
327 | 0 | final String methodName = methodNameAst.getText(); |
328 | |
|
329 | 0 | return type == TokenTypes.METHOD_DEF |
330 | |
&& ("writeObject".equals(methodName) |
331 | |
|| "readObject".equals(methodName) |
332 | |
|| "writeExternal".equals(methodName) |
333 | |
|| "readExternal".equals(methodName) |
334 | |
|| "writeReplace".equals(methodName) |
335 | |
|| "readResolve" |
336 | |
.equals(methodName)); |
337 | |
} |
338 | |
}, |
339 | |
|
340 | |
|
341 | |
|
342 | |
|
343 | 1 | SERIAL_FIELD("@serialField", "serialField", Type.BLOCK, false, false) |
344 | |
{ |
345 | |
|
346 | |
@Override |
347 | |
public boolean isValidOn(final DetailAST aAst) |
348 | |
{ |
349 | 0 | final int type = aAst.getType(); |
350 | 0 | final DetailAST varType = aAst.findFirstToken(TokenTypes.TYPE); |
351 | |
|
352 | 0 | return type == TokenTypes.VARIABLE_DEF |
353 | |
&& varType.getType() == TokenTypes.ARRAY_DECLARATOR |
354 | |
&& "ObjectStreamField" |
355 | |
.equals(varType.getFirstChild().getText()); |
356 | |
} |
357 | |
}, |
358 | |
|
359 | |
|
360 | |
|
361 | |
|
362 | 1 | SINCE("@since", "since", Type.BLOCK, true, true) |
363 | |
{ |
364 | |
|
365 | |
@Override |
366 | |
public boolean isValidOn(final DetailAST aAst) |
367 | |
{ |
368 | 0 | final int type = aAst.getType(); |
369 | 0 | return type == TokenTypes.PACKAGE_DEF |
370 | |
|| type == TokenTypes.CLASS_DEF |
371 | |
|| type == TokenTypes.INTERFACE_DEF |
372 | |
|| type == TokenTypes.ENUM_DEF |
373 | |
|| type == TokenTypes.ANNOTATION_DEF |
374 | |
|| type == TokenTypes.METHOD_DEF |
375 | |
|| type == TokenTypes.CTOR_DEF |
376 | |
|| (type == TokenTypes.VARIABLE_DEF |
377 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
378 | |
} |
379 | |
}, |
380 | |
|
381 | |
|
382 | |
|
383 | |
|
384 | 1 | THROWS("@throws", "throws", Type.BLOCK, false, false) |
385 | |
{ |
386 | |
|
387 | |
@Override |
388 | |
public boolean isValidOn(final DetailAST aAst) |
389 | |
{ |
390 | 0 | final int type = aAst.getType(); |
391 | 0 | return type == TokenTypes.METHOD_DEF |
392 | |
|| type == TokenTypes.CTOR_DEF; |
393 | |
} |
394 | |
}, |
395 | |
|
396 | |
|
397 | |
|
398 | |
|
399 | 1 | VALUE("{@value}", "value", Type.INLINE, true, true) |
400 | |
{ |
401 | |
|
402 | |
@Override |
403 | |
public boolean isValidOn(final DetailAST aAst) |
404 | |
{ |
405 | 0 | final int type = aAst.getType(); |
406 | 0 | return type == TokenTypes.PACKAGE_DEF |
407 | |
|| type == TokenTypes.CLASS_DEF |
408 | |
|| type == TokenTypes.INTERFACE_DEF |
409 | |
|| type == TokenTypes.ENUM_DEF |
410 | |
|| type == TokenTypes.ANNOTATION_DEF |
411 | |
|| type == TokenTypes.METHOD_DEF |
412 | |
|| type == TokenTypes.CTOR_DEF |
413 | |
|| (type == TokenTypes.VARIABLE_DEF |
414 | |
&& !ScopeUtils.isLocalVariableDef(aAst)); |
415 | |
} |
416 | |
}, |
417 | |
|
418 | |
|
419 | |
|
420 | |
|
421 | 1 | VERSION("@version", "version", Type.BLOCK, true, true) |
422 | |
{ |
423 | |
|
424 | |
@Override |
425 | |
public boolean isValidOn(final DetailAST aAst) |
426 | |
{ |
427 | 0 | final int type = aAst.getType(); |
428 | 0 | return type == TokenTypes.PACKAGE_DEF |
429 | |
|| type == TokenTypes.CLASS_DEF |
430 | |
|| type == TokenTypes.INTERFACE_DEF |
431 | |
|| type == TokenTypes.ENUM_DEF |
432 | |
|| type == TokenTypes.ANNOTATION_DEF; |
433 | |
} |
434 | |
}; |
435 | |
|
436 | |
|
437 | |
private static final Map<String, JavadocTagInfo> TEXT_TO_TAG; |
438 | |
|
439 | |
private static final Map<String, JavadocTagInfo> NAME_TO_TAG; |
440 | |
|
441 | |
static |
442 | |
{ |
443 | 1 | final ImmutableMap.Builder<String, JavadocTagInfo> textToTagBuilder = |
444 | |
new ImmutableMap.Builder<String, JavadocTagInfo>(); |
445 | |
|
446 | 1 | final ImmutableMap.Builder<String, JavadocTagInfo> nameToTagBuilder = |
447 | |
new ImmutableMap.Builder<String, JavadocTagInfo>(); |
448 | |
|
449 | 20 | for (final JavadocTagInfo tag : JavadocTagInfo.values()) { |
450 | 19 | textToTagBuilder.put(tag.getText(), tag); |
451 | 19 | nameToTagBuilder.put(tag.getName(), tag); |
452 | |
} |
453 | |
|
454 | 1 | TEXT_TO_TAG = textToTagBuilder.build(); |
455 | 1 | NAME_TO_TAG = nameToTagBuilder.build(); |
456 | 1 | } |
457 | |
|
458 | |
|
459 | |
private final String mText; |
460 | |
|
461 | |
private final String mName; |
462 | |
|
463 | |
private final Type mType; |
464 | |
|
465 | |
private final boolean mValidInPackageHtml; |
466 | |
|
467 | |
private final boolean mValidInOverviewHtml; |
468 | |
|
469 | |
|
470 | |
|
471 | |
|
472 | |
|
473 | |
|
474 | |
|
475 | |
|
476 | |
|
477 | |
|
478 | |
|
479 | |
|
480 | |
private JavadocTagInfo(final String aText, final String aName, |
481 | |
final Type aType, final boolean aValidInPackageHtml, |
482 | |
final boolean aValidInOverviewHtml) |
483 | 19 | { |
484 | 19 | this.mText = aText; |
485 | 19 | this.mName = aName; |
486 | 19 | this.mType = aType; |
487 | 19 | this.mValidInPackageHtml = aValidInPackageHtml; |
488 | 19 | this.mValidInOverviewHtml = aValidInOverviewHtml; |
489 | 19 | } |
490 | |
|
491 | |
|
492 | |
|
493 | |
|
494 | |
|
495 | |
|
496 | |
|
497 | |
|
498 | |
|
499 | |
|
500 | |
|
501 | |
|
502 | |
|
503 | |
|
504 | |
|
505 | |
|
506 | |
|
507 | |
|
508 | |
|
509 | |
|
510 | |
public abstract boolean isValidOn(DetailAST aAST); |
511 | |
|
512 | |
|
513 | |
|
514 | |
|
515 | |
|
516 | |
|
517 | |
public boolean isValidInPackageHtml() |
518 | |
{ |
519 | 0 | return this.mValidInPackageHtml; |
520 | |
} |
521 | |
|
522 | |
|
523 | |
|
524 | |
|
525 | |
|
526 | |
|
527 | |
public boolean isValidInOverviewHtml() |
528 | |
{ |
529 | 0 | return this.mValidInOverviewHtml; |
530 | |
} |
531 | |
|
532 | |
|
533 | |
|
534 | |
|
535 | |
|
536 | |
public String getText() |
537 | |
{ |
538 | 95 | return this.mText; |
539 | |
} |
540 | |
|
541 | |
|
542 | |
|
543 | |
|
544 | |
|
545 | |
public String getName() |
546 | |
{ |
547 | 231 | return this.mName; |
548 | |
} |
549 | |
|
550 | |
|
551 | |
|
552 | |
|
553 | |
|
554 | |
public Type getType() |
555 | |
{ |
556 | 0 | return this.mType; |
557 | |
} |
558 | |
|
559 | |
|
560 | |
|
561 | |
|
562 | |
|
563 | |
|
564 | |
|
565 | |
|
566 | |
public static JavadocTagInfo fromText(final String aText) |
567 | |
{ |
568 | 0 | if (aText == null) { |
569 | 0 | throw new NullPointerException("the text is null"); |
570 | |
} |
571 | |
|
572 | 0 | final JavadocTagInfo tag = TEXT_TO_TAG.get(aText); |
573 | |
|
574 | 0 | if (tag == null) { |
575 | 0 | throw new IllegalArgumentException("the text [" + aText |
576 | |
+ "] is not a valid Javadoc tag text"); |
577 | |
} |
578 | |
|
579 | 0 | return tag; |
580 | |
} |
581 | |
|
582 | |
|
583 | |
|
584 | |
|
585 | |
|
586 | |
|
587 | |
|
588 | |
|
589 | |
|
590 | |
public static JavadocTagInfo fromName(final String aName) |
591 | |
{ |
592 | 309 | if (aName == null) { |
593 | 0 | throw new NullPointerException("the name is null"); |
594 | |
} |
595 | |
|
596 | 309 | final JavadocTagInfo tag = NAME_TO_TAG.get(aName); |
597 | |
|
598 | 309 | if (tag == null) { |
599 | 0 | throw new IllegalArgumentException("the name [" + aName |
600 | |
+ "] is not a valid Javadoc tag name"); |
601 | |
} |
602 | |
|
603 | 309 | return tag; |
604 | |
} |
605 | |
|
606 | |
|
607 | |
|
608 | |
|
609 | |
|
610 | |
|
611 | |
public static boolean isValidName(final String aName) |
612 | |
{ |
613 | 120 | return NAME_TO_TAG.containsKey(aName); |
614 | |
} |
615 | |
|
616 | |
|
617 | |
|
618 | |
|
619 | |
@Override |
620 | |
public String toString() |
621 | |
{ |
622 | 0 | return "text [" + this.mText + "] name [" + this.mName |
623 | |
+ "] type [" + this.mType |
624 | |
+ "] validInPackageHtml [" + this.mValidInPackageHtml |
625 | |
+ "] validInOverviewHtml [" + this.mValidInOverviewHtml + "]"; |
626 | |
} |
627 | |
|
628 | |
|
629 | |
|
630 | |
|
631 | |
|
632 | |
|
633 | |
|
634 | |
|
635 | |
|
636 | 3 | public enum Type |
637 | |
{ |
638 | |
|
639 | 1 | BLOCK, |
640 | |
|
641 | |
|
642 | 1 | INLINE; |
643 | |
} |
644 | |
} |