blob: 78d1aa9c858a8521ba38bdca6712e0a59e10f5a8 (
plain)
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
|
/*
* Copyright 2000-2013 JetBrains s.r.o.
*
* 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.logging;
import com.intellij.openapi.util.InvalidDataException;
import com.intellij.openapi.util.WriteExternalException;
import com.intellij.psi.*;
import com.siyeh.InspectionGadgetsBundle;
import com.siyeh.ig.BaseInspection;
import com.siyeh.ig.BaseInspectionVisitor;
import com.siyeh.ig.InspectionGadgetsFix;
import com.siyeh.ig.fixes.MakeFieldStaticFinalFix;
import org.jdom.Element;
import org.jetbrains.annotations.NotNull;
import java.util.ArrayList;
import java.util.List;
public class NonStaticFinalLoggerInspectionBase extends BaseInspection {
protected final List<String> loggerClassNames = new ArrayList();
@SuppressWarnings("PublicField")
public String loggerClassName = "java.util.logging.Logger" + ',' +
"org.slf4j.Logger" + ',' +
"org.apache.commons.logging.Log" + ',' +
"org.apache.log4j.Logger";
@Override
@NotNull
public String getID() {
return "NonConstantLogger";
}
@Override
@NotNull
public String getDisplayName() {
return InspectionGadgetsBundle.message("non.constant.logger.display.name");
}
@Override
@NotNull
protected String buildErrorString(Object... infos) {
return InspectionGadgetsBundle.message("non.constant.logger.problem.descriptor");
}
@Override
protected InspectionGadgetsFix buildFix(Object... infos) {
final PsiField field = (PsiField)infos[0];
return MakeFieldStaticFinalFix.buildFixUnconditional(field);
}
@Override
public void readSettings(@NotNull Element element) throws InvalidDataException {
super.readSettings(element);
parseString(loggerClassName, loggerClassNames);
}
@Override
public void writeSettings(@NotNull Element element) throws WriteExternalException {
loggerClassName = formatString(loggerClassNames);
super.writeSettings(element);
}
@Override
public BaseInspectionVisitor buildVisitor() {
return new NonStaticFinalLoggerVisitor();
}
private class NonStaticFinalLoggerVisitor extends BaseInspectionVisitor {
@Override
public void visitClass(@NotNull PsiClass aClass) {
if (aClass.isInterface() || aClass.isEnum() || aClass.isAnnotationType()) {
return;
}
if (aClass instanceof PsiTypeParameter) {
return;
}
if (aClass.getContainingClass() != null) {
return;
}
final PsiField[] fields = aClass.getFields();
for (final PsiField field : fields) {
if (!isLogger(field)) {
continue;
}
if (field.hasModifierProperty(PsiModifier.STATIC) && field.hasModifierProperty(PsiModifier.FINAL)) {
continue;
}
registerFieldError(field, field);
}
}
private boolean isLogger(PsiVariable variable) {
final PsiType type = variable.getType();
final String text = type.getCanonicalText();
return loggerClassNames.contains(text);
}
}
}
|
