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.javadoc; |
20 | |
|
21 | |
import com.puppycrawl.tools.checkstyle.api.Check; |
22 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
23 | |
import com.puppycrawl.tools.checkstyle.api.FileContents; |
24 | |
import com.puppycrawl.tools.checkstyle.api.Scope; |
25 | |
import com.puppycrawl.tools.checkstyle.api.ScopeUtils; |
26 | |
import com.puppycrawl.tools.checkstyle.api.TextBlock; |
27 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | |
|
36 | 8 | public class JavadocVariableCheck |
37 | |
extends Check |
38 | |
{ |
39 | |
|
40 | 8 | private Scope mScope = Scope.PRIVATE; |
41 | |
|
42 | |
|
43 | |
private Scope mExcludeScope; |
44 | |
|
45 | |
|
46 | |
|
47 | |
|
48 | |
|
49 | |
public void setScope(String aFrom) |
50 | |
{ |
51 | 4 | mScope = Scope.getInstance(aFrom); |
52 | 4 | } |
53 | |
|
54 | |
|
55 | |
|
56 | |
|
57 | |
|
58 | |
public void setExcludeScope(String aScope) |
59 | |
{ |
60 | 1 | mExcludeScope = Scope.getInstance(aScope); |
61 | 1 | } |
62 | |
|
63 | |
@Override |
64 | |
public int[] getDefaultTokens() |
65 | |
{ |
66 | 8 | return new int[] { |
67 | |
TokenTypes.VARIABLE_DEF, |
68 | |
TokenTypes.ENUM_CONSTANT_DEF, |
69 | |
}; |
70 | |
} |
71 | |
|
72 | |
@Override |
73 | |
public void visitToken(DetailAST aAST) |
74 | |
{ |
75 | 164 | if (shouldCheck(aAST)) { |
76 | 99 | final FileContents contents = getFileContents(); |
77 | 99 | final TextBlock cmt = |
78 | |
contents.getJavadocBefore(aAST.getLineNo()); |
79 | |
|
80 | 99 | if (cmt == null) { |
81 | 87 | log(aAST, "javadoc.missing"); |
82 | |
} |
83 | |
} |
84 | 164 | } |
85 | |
|
86 | |
|
87 | |
|
88 | |
|
89 | |
|
90 | |
|
91 | |
private boolean shouldCheck(final DetailAST aAST) |
92 | |
{ |
93 | 164 | if (ScopeUtils.inCodeBlock(aAST)) { |
94 | 12 | return false; |
95 | |
} |
96 | |
|
97 | |
final Scope scope; |
98 | 152 | if (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF) { |
99 | 7 | scope = Scope.PUBLIC; |
100 | |
} |
101 | |
else { |
102 | 145 | final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS); |
103 | 145 | final Scope declaredScope = ScopeUtils.getScopeFromMods(mods); |
104 | 145 | scope = |
105 | |
ScopeUtils.inInterfaceOrAnnotationBlock(aAST) |
106 | |
? Scope.PUBLIC : declaredScope; |
107 | |
} |
108 | |
|
109 | 152 | final Scope surroundingScope = ScopeUtils.getSurroundingScope(aAST); |
110 | |
|
111 | 152 | return scope.isIn(mScope) && surroundingScope.isIn(mScope) |
112 | |
&& ((mExcludeScope == null) |
113 | |
|| !scope.isIn(mExcludeScope) |
114 | |
|| !surroundingScope.isIn(mExcludeScope)); |
115 | |
} |
116 | |
|
117 | |
} |