-
Notifications
You must be signed in to change notification settings - Fork 111
/
JavadocEmptyLineCheck.java
171 lines (160 loc) · 5.96 KB
/
JavadocEmptyLineCheck.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
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
/*
* Copyright (c) 2011-2021, Qulice.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the Qulice.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.qulice.checkstyle;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Check for empty line at the beginning and at the end of Javadoc.
*
* <p>You can't have empty line at the beginning or at the end of Javadoc.
*
* <p>The following red lines in class Javadoc will be reported as violations.
* <pre>
* /**
* <span style="color:red" >*</span>
* * This is my class.
* <span style="color:red" >*</span>
* */
* public final class Foo {
* // ...
* </pre>
*
* @since 0.17
*/
public final class JavadocEmptyLineCheck extends AbstractCheck {
@Override
public int[] getDefaultTokens() {
return new int[] {
TokenTypes.PACKAGE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
};
}
@Override
public int[] getAcceptableTokens() {
return this.getDefaultTokens();
}
@Override
public int[] getRequiredTokens() {
return this.getDefaultTokens();
}
@Override
public void visitToken(final DetailAST ast) {
final String[] lines = this.getLines();
final int current = ast.getLineNo();
final int start =
JavadocEmptyLineCheck.findCommentStart(lines, current) + 1;
if (JavadocEmptyLineCheck.isNodeHavingJavadoc(ast, start)) {
if (JavadocEmptyLineCheck.isJavadocLineEmpty(lines[start])) {
this.log(start + 1, "Empty Javadoc line at the beginning");
}
final int end =
JavadocEmptyLineCheck.findCommentEnd(lines, current) - 1;
if (JavadocEmptyLineCheck.isJavadocLineEmpty(lines[end])) {
this.log(end + 1, "Empty Javadoc line at the end");
}
}
}
/**
* Check if Javadoc line is empty.
* @param line Javadoc line
* @return True when Javadoc line is empty
*/
private static boolean isJavadocLineEmpty(final String line) {
return "*".equals(line.trim());
}
/**
* Check if node has Javadoc.
* @param node Node to be checked for Javadoc.
* @param start Line number where comment starts.
* @return True when node has Javadoc
*/
private static boolean isNodeHavingJavadoc(final DetailAST node,
final int start) {
return start > getLineNoOfPreviousNode(node);
}
/**
* Returns line number of previous node.
* @param node Current node.
* @return Line number of previous node
*/
private static int getLineNoOfPreviousNode(final DetailAST node) {
int start = 0;
final DetailAST previous = node.getPreviousSibling();
if (previous != null) {
start = previous.getLineNo();
}
return start;
}
/**
* Find Javadoc starting comment.
* @param lines List of lines to check.
* @param start Start searching from this line number.
* @return Line number with found starting comment or -1 otherwise.
*/
private static int findCommentStart(final String[] lines, final int start) {
return JavadocEmptyLineCheck.findTrimmedTextUp(lines, start, "/**");
}
/**
* Find Javadoc ending comment.
* @param lines Array of lines to check.
* @param start Start searching from this line number.
* @return Line number with found ending comment, or -1 if it wasn't found.
*/
private static int findCommentEnd(final String[] lines, final int start) {
return JavadocEmptyLineCheck.findTrimmedTextUp(lines, start, "*/");
}
/**
* Find a text in lines, by going up.
* @param lines Array of lines to check.
* @param start Start searching from this line number.
* @param text Text to find.
* @return Line number with found text, or -1 if it wasn't found.
*/
private static int findTrimmedTextUp(final String[] lines,
final int start, final String text) {
int found = -1;
for (int pos = start - 1; pos >= 0; pos -= 1) {
if (lines[pos].trim().equals(text)) {
found = pos;
break;
}
}
return found;
}
}