/
WildcardReturnParameterTypeCheck.java
84 lines (73 loc) · 3.12 KB
/
WildcardReturnParameterTypeCheck.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*
* SonarQube Java
* Copyright (C) 2012-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.java.checks;
import java.util.Collections;
import java.util.List;
import org.sonar.check.Rule;
import org.sonar.java.model.ModifiersUtils;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.semantic.Type;
import org.sonar.plugins.java.api.tree.BaseTreeVisitor;
import org.sonar.plugins.java.api.tree.MethodTree;
import org.sonar.plugins.java.api.tree.Modifier;
import org.sonar.plugins.java.api.tree.ParameterizedTypeTree;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.TypeArguments;
import org.sonar.plugins.java.api.tree.WildcardTree;
@Rule(key = "S1452")
public class WildcardReturnParameterTypeCheck extends IssuableSubscriptionVisitor {
@Override
public List<Tree.Kind> nodesToVisit() {
return Collections.singletonList(Tree.Kind.METHOD);
}
@Override
public void visitNode(Tree tree) {
MethodTree methodTree = (MethodTree) tree;
if (!isPrivate(methodTree) && isNotOverriding(methodTree)) {
methodTree.returnType().accept(new CheckWildcard());
}
}
private static boolean isPrivate(MethodTree methodTree) {
return ModifiersUtils.hasModifier(methodTree.modifiers(), Modifier.PRIVATE);
}
private static boolean isNotOverriding(MethodTree tree) {
return Boolean.FALSE.equals(tree.isOverriding());
}
private class CheckWildcard extends BaseTreeVisitor {
@Override
public void visitParameterizedType(ParameterizedTypeTree tree) {
Type symbolType = tree.type().symbolType();
TypeArguments typeArguments = tree.typeArguments();
if (typeArguments.size() == 3 && symbolType.is("java.util.stream.Collector")) {
// Second type parameter of Collector is ignored as it is an implementation detail
reportIfWildcard(typeArguments.get(0));
reportIfWildcard(typeArguments.get(2));
} else if (!symbolType.is("java.lang.Class") && !symbolType.isUnknown()) {
typeArguments.forEach(this::reportIfWildcard);
}
super.visitParameterizedType(tree);
}
private void reportIfWildcard(Tree tree) {
if (tree.is(Tree.Kind.EXTENDS_WILDCARD, Tree.Kind.UNBOUNDED_WILDCARD, Tree.Kind.SUPER_WILDCARD)) {
reportIssue(((WildcardTree) tree).queryToken(), "Remove usage of generic wildcard type.");
}
}
}
}