1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
package com.puppycrawl.tools.checkstyle.checks.design; |
20 | |
|
21 | |
import com.puppycrawl.tools.checkstyle.api.Check; |
22 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
23 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
24 | |
|
25 | |
|
26 | |
|
27 | |
|
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | 7 | public class HideUtilityClassConstructorCheck extends Check |
36 | |
{ |
37 | |
@Override |
38 | |
public int[] getDefaultTokens() |
39 | |
{ |
40 | 7 | return new int[] {TokenTypes.CLASS_DEF}; |
41 | |
} |
42 | |
|
43 | |
@Override |
44 | |
public void visitToken(DetailAST aAST) |
45 | |
{ |
46 | 12 | if (isAbstract(aAST)) { |
47 | |
|
48 | 2 | return; |
49 | |
} |
50 | |
|
51 | 10 | final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK); |
52 | 10 | DetailAST child = objBlock.getFirstChild(); |
53 | 10 | final boolean hasStaticModifier = isStatic(aAST); |
54 | 10 | boolean hasMethodOrField = false; |
55 | 10 | boolean hasNonStaticMethodOrField = false; |
56 | 10 | boolean hasNonPrivateStaticMethodOrField = false; |
57 | 10 | boolean hasDefaultCtor = true; |
58 | 10 | boolean hasPublicCtor = false; |
59 | |
|
60 | 58 | while (child != null) { |
61 | 48 | final int type = child.getType(); |
62 | 48 | if (type == TokenTypes.METHOD_DEF |
63 | |
|| type == TokenTypes.VARIABLE_DEF) |
64 | |
{ |
65 | 21 | hasMethodOrField = true; |
66 | 21 | final DetailAST modifiers = |
67 | |
child.findFirstToken(TokenTypes.MODIFIERS); |
68 | 21 | final boolean isStatic = |
69 | |
modifiers.branchContains(TokenTypes.LITERAL_STATIC); |
70 | 21 | final boolean isPrivate = |
71 | |
modifiers.branchContains(TokenTypes.LITERAL_PRIVATE); |
72 | |
|
73 | 21 | if (!isStatic && !isPrivate) { |
74 | 7 | hasNonStaticMethodOrField = true; |
75 | |
} |
76 | 21 | if (isStatic && !isPrivate) { |
77 | 6 | hasNonPrivateStaticMethodOrField = true; |
78 | |
} |
79 | |
} |
80 | 48 | if (type == TokenTypes.CTOR_DEF) { |
81 | 4 | hasDefaultCtor = false; |
82 | 4 | final DetailAST modifiers = |
83 | |
child.findFirstToken(TokenTypes.MODIFIERS); |
84 | 4 | if (!modifiers.branchContains(TokenTypes.LITERAL_PRIVATE) |
85 | |
&& !modifiers.branchContains(TokenTypes.LITERAL_PROTECTED)) |
86 | |
{ |
87 | |
|
88 | |
|
89 | 3 | hasPublicCtor = true; |
90 | |
} |
91 | |
|
92 | |
} |
93 | 48 | child = child.getNextSibling(); |
94 | 48 | } |
95 | |
|
96 | 10 | final boolean hasAccessibleCtor = (hasDefaultCtor || hasPublicCtor); |
97 | |
|
98 | |
|
99 | |
|
100 | |
|
101 | |
|
102 | 10 | final boolean extendsJLO = |
103 | |
aAST.findFirstToken(TokenTypes.EXTENDS_CLAUSE) == null; |
104 | |
|
105 | 10 | final boolean isUtilClass = extendsJLO && hasMethodOrField |
106 | |
&& !hasNonStaticMethodOrField && hasNonPrivateStaticMethodOrField; |
107 | |
|
108 | 10 | if (isUtilClass && (hasAccessibleCtor && !hasStaticModifier)) { |
109 | 1 | log(aAST.getLineNo(), aAST.getColumnNo(), "hide.utility.class"); |
110 | |
} |
111 | 10 | } |
112 | |
|
113 | |
|
114 | |
|
115 | |
|
116 | |
|
117 | |
private boolean isAbstract(DetailAST aAST) |
118 | |
{ |
119 | 12 | return aAST.findFirstToken(TokenTypes.MODIFIERS) |
120 | |
.branchContains(TokenTypes.ABSTRACT); |
121 | |
} |
122 | |
|
123 | |
|
124 | |
|
125 | |
|
126 | |
|
127 | |
private boolean isStatic(DetailAST aAST) |
128 | |
{ |
129 | 10 | return aAST.findFirstToken(TokenTypes.MODIFIERS) |
130 | |
.branchContains(TokenTypes.LITERAL_STATIC); |
131 | |
} |
132 | |
} |