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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/*
* Copyright 2003-2014 Dave Griffith, Bas Leijdekkers
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.siyeh.ig.style;
import com.intellij.codeInspection.CleanupLocalInspectionTool;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.codeInspection.ProblemHighlightType;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiUtil;
import com.siyeh.InspectionGadgetsBundle;
import com.siyeh.ig.BaseInspection;
import com.siyeh.ig.BaseInspectionVisitor;
import com.siyeh.ig.InspectionGadgetsFix;
import com.siyeh.ig.psiutils.ClassUtils;
import org.jetbrains.annotations.NotNull;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
public class UnnecessaryInterfaceModifierInspection extends BaseInspection implements CleanupLocalInspectionTool{
private static final Set<String> INTERFACE_REDUNDANT_MODIFIERS =
new HashSet<String>(Arrays.asList(PsiModifier.ABSTRACT, PsiModifier.STATIC));
private static final Set<String> INNER_CLASS_REDUNDANT_MODIFIERS =
new HashSet<String>(Arrays.asList(PsiModifier.PUBLIC, PsiModifier.STATIC));
private static final Set<String> INNER_INTERFACE_REDUNDANT_MODIFIERS =
new HashSet<String>(Arrays.asList(PsiModifier.PUBLIC, PsiModifier.ABSTRACT, PsiModifier.STATIC));
private static final Set<String> FIELD_REDUNDANT_MODIFIERS =
new HashSet<String>(Arrays.asList(PsiModifier.PUBLIC, PsiModifier.STATIC, PsiModifier.FINAL));
private static final Set<String> METHOD_REDUNDANT_MODIFIERS =
new HashSet<String>(Arrays.asList(PsiModifier.PUBLIC, PsiModifier.ABSTRACT));
@Override
@NotNull
public String getDisplayName() {
return InspectionGadgetsBundle.message("unnecessary.interface.modifier.display.name");
}
@Override
@NotNull
public String buildErrorString(Object... infos) {
final PsiModifierList modifierList = (PsiModifierList)infos[1];
final PsiElement parent = modifierList.getParent();
if (parent instanceof PsiClass) {
final PsiClass aClass = (PsiClass)parent;
final PsiClass containingClass = aClass.getContainingClass();
if (containingClass != null) {
if (aClass.isInterface()) {
return InspectionGadgetsBundle.message("unnecessary.interface.modifier.inner.interface.of.interface.problem.descriptor");
}
else {
return InspectionGadgetsBundle.message("unnecessary.interface.modifier.problem.descriptor3");
}
}
else {
return InspectionGadgetsBundle.message("unnecessary.interface.modifier.problem.descriptor");
}
}
else if (parent instanceof PsiMethod) {
return InspectionGadgetsBundle.message("unnecessary.interface.modifier.problem.descriptor2");
}
else {
return InspectionGadgetsBundle.message("unnecessary.interface.modifier.problem.descriptor4");
}
}
@Override
public BaseInspectionVisitor buildVisitor() {
return new UnnecessaryInterfaceModifierVisitor();
}
@Override
public InspectionGadgetsFix buildFix(Object... infos) {
return new UnnecessaryInterfaceModifiersFix((String)infos[0]);
}
private static class UnnecessaryInterfaceModifiersFix extends InspectionGadgetsFix {
private final String modifiersText;
private UnnecessaryInterfaceModifiersFix(String modifiersText) {
this.modifiersText = modifiersText;
}
@Override
@NotNull
public String getName() {
return InspectionGadgetsBundle.message("smth.unnecessary.remove.quickfix", modifiersText);
}
@NotNull
@Override
public String getFamilyName() {
return "Remove unnecessary modifiers";
}
@Override
public void doFix(Project project, ProblemDescriptor descriptor) {
final PsiElement element = descriptor.getPsiElement();
final PsiModifierList modifierList;
if (element instanceof PsiModifierList) {
modifierList = (PsiModifierList)element;
}
else {
final PsiElement parent = element.getParent();
if (!(parent instanceof PsiModifierList)) {
return;
}
modifierList = (PsiModifierList)parent;
}
final PsiElement modifierOwner = modifierList.getParent();
if (!(modifierOwner instanceof PsiMethod && PsiUtil.isLanguageLevel8OrHigher(modifierList))) {
modifierList.setModifierProperty(PsiModifier.STATIC, false);
}
assert modifierOwner != null;
if (modifierOwner instanceof PsiClass) {
final PsiClass aClass = (PsiClass)modifierOwner;
if (aClass.isInterface()) {
modifierList.setModifierProperty(PsiModifier.ABSTRACT, false);
}
final PsiClass containingClass = ClassUtils.getContainingClass(modifierOwner);
if (containingClass != null && containingClass.isInterface()) {
// do the inner classes
modifierList.setModifierProperty(PsiModifier.PUBLIC, false);
}
}
else if (modifierOwner instanceof PsiMethod) {
modifierList.setModifierProperty(PsiModifier.ABSTRACT, false);
modifierList.setModifierProperty(PsiModifier.PUBLIC, false);
}
else {
modifierList.setModifierProperty(PsiModifier.PUBLIC, false);
modifierList.setModifierProperty(PsiModifier.FINAL, false);
}
}
}
private static class UnnecessaryInterfaceModifierVisitor extends BaseInspectionVisitor {
@Override
public void visitClass(@NotNull PsiClass aClass) {
final PsiClass parent = ClassUtils.getContainingClass(aClass);
if (parent != null && parent.isInterface()) {
final PsiModifierList modifiers = aClass.getModifierList();
if (aClass.isInterface()) {
checkForRedundantModifiers(modifiers, INNER_INTERFACE_REDUNDANT_MODIFIERS);
}
else {
checkForRedundantModifiers(modifiers, INNER_CLASS_REDUNDANT_MODIFIERS);
}
}
else if (aClass.isInterface()) {
final PsiModifierList modifiers = aClass.getModifierList();
checkForRedundantModifiers(modifiers, INTERFACE_REDUNDANT_MODIFIERS);
}
}
@Override
public void visitField(@NotNull PsiField field) {
// don't call super, to keep this from drilling in
final PsiClass containingClass = field.getContainingClass();
if (containingClass == null) {
return;
}
if (!containingClass.isInterface()) {
return;
}
final PsiModifierList modifiers = field.getModifierList();
checkForRedundantModifiers(modifiers, FIELD_REDUNDANT_MODIFIERS);
}
@Override
public void visitMethod(@NotNull PsiMethod method) {
// don't call super, to keep this from drilling in
final PsiClass aClass = method.getContainingClass();
if (aClass == null) {
return;
}
if (!aClass.isInterface()) {
return;
}
final PsiModifierList modifiers = method.getModifierList();
checkForRedundantModifiers(modifiers, METHOD_REDUNDANT_MODIFIERS);
}
public void checkForRedundantModifiers(PsiModifierList list, Set<String> modifiers) {
if (list == null) {
return;
}
final PsiElement[] children = list.getChildren();
final StringBuilder redundantModifiers = new StringBuilder();
for (PsiElement child : children) {
final String modifierText = child.getText();
if (modifiers.contains(modifierText)) {
if (redundantModifiers.length() > 0) {
redundantModifiers.append(' ');
}
redundantModifiers.append(modifierText);
}
}
for (PsiElement child : children) {
if (modifiers.contains(child.getText())) {
registerError(child, ProblemHighlightType.LIKE_UNUSED_SYMBOL, redundantModifiers.toString(), list);
}
}
}
}
}
|
