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.coding;
21
22 import java.util.Arrays;
23 import java.util.Collections;
24 import java.util.HashSet;
25 import java.util.Set;
26 import java.util.stream.Collectors;
27
28 import com.puppycrawl.tools.checkstyle.StatelessCheck;
29 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
30 import com.puppycrawl.tools.checkstyle.api.DetailAST;
31 import com.puppycrawl.tools.checkstyle.api.FullIdent;
32 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
33 import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil;
34 import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
35
36
37
38
39
40
41
42
43
44
45 @StatelessCheck
46 public final class IllegalThrowsCheck extends AbstractCheck {
47
48
49
50
51
52 public static final String MSG_KEY = "illegal.throw";
53
54
55 private final Set<String> ignoredMethodNames =
56 Arrays.stream(new String[] {"finalize", }).collect(Collectors.toCollection(HashSet::new));
57
58
59 private final Set<String> illegalClassNames = Arrays.stream(
60 new String[] {"Error", "RuntimeException", "Throwable", "java.lang.Error",
61 "java.lang.RuntimeException", "java.lang.Throwable", })
62 .collect(Collectors.toCollection(HashSet::new));
63
64
65
66
67
68 private boolean ignoreOverriddenMethods = true;
69
70
71
72
73
74
75
76
77 public void setIllegalClassNames(final String... classNames) {
78 illegalClassNames.clear();
79 illegalClassNames.addAll(
80 CheckUtil.parseClassNames(classNames));
81 }
82
83 @Override
84 public int[] getDefaultTokens() {
85 return getRequiredTokens();
86 }
87
88 @Override
89 public int[] getRequiredTokens() {
90 return new int[] {TokenTypes.LITERAL_THROWS};
91 }
92
93 @Override
94 public int[] getAcceptableTokens() {
95 return getRequiredTokens();
96 }
97
98 @Override
99 public void visitToken(DetailAST detailAST) {
100 final DetailAST methodDef = detailAST.getParent();
101
102 if (!isIgnorableMethod(methodDef)) {
103 DetailAST token = detailAST.getFirstChild();
104 while (token != null) {
105 final FullIdent ident = FullIdent.createFullIdent(token);
106 final String identText = ident.getText();
107 if (illegalClassNames.contains(identText)) {
108 log(token, MSG_KEY, identText);
109 }
110 token = token.getNextSibling();
111 }
112 }
113 }
114
115
116
117
118
119
120
121 private boolean isIgnorableMethod(DetailAST methodDef) {
122 return shouldIgnoreMethod(methodDef.findFirstToken(TokenTypes.IDENT).getText())
123 || ignoreOverriddenMethods
124 && AnnotationUtil.hasOverrideAnnotation(methodDef);
125 }
126
127
128
129
130
131
132
133 private boolean shouldIgnoreMethod(String name) {
134 return ignoredMethodNames.contains(name);
135 }
136
137
138
139
140
141
142
143 public void setIgnoredMethodNames(String... methodNames) {
144 ignoredMethodNames.clear();
145 Collections.addAll(ignoredMethodNames, methodNames);
146 }
147
148
149
150
151
152
153
154
155 public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods) {
156 this.ignoreOverriddenMethods = ignoreOverriddenMethods;
157 }
158
159 }