/
PackageAnnotationCheck.java
116 lines (106 loc) · 3.64 KB
/
PackageAnnotationCheck.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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2022 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.annotation;
import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil;
import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
/**
* <p>
* Checks that all package annotations are in the package-info.java file.
* </p>
* <p>
* For Java SE8 and above, placement of package annotations in the package-info.java
* file is enforced by the compiler and this check is not necessary.
* </p>
* <p>
* For Java SE7 and below, the Java Language Specification highly recommends
* but doesn't require that annotations are placed in the package-info.java file,
* and this check can help to enforce that placement.
* </p>
* <p>
* See <a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-7.html#jls-7.4.1">
* Java Language Specification, §7.4.1</a> for more info.
* </p>
* <p>
* To configure the check:
* </p>
* <pre>
* <module name="PackageAnnotation"/>
* </pre>
* <p>Example of validating MyClass.java:</p>
* <pre>
* @Deprecated
* package com.example.annotations.packageannotation; //violation
* </pre>
* <p>Example of fixing violation in MyClass.java:</p>
* <pre>
* package com.example.annotations.packageannotation; //ok
* </pre>
* <p>Example of validating package-info.java:</p>
* <pre>
* @Deprecated
* package com.example.annotations.packageannotation; //ok
* </pre>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code annotation.package.location}
* </li>
* </ul>
*
* @since 5.0
*/
@StatelessCheck
public class PackageAnnotationCheck extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "annotation.package.location";
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {
TokenTypes.PACKAGE_DEF,
};
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public void visitToken(final DetailAST ast) {
final boolean containsAnnotation =
AnnotationUtil.containsAnnotation(ast);
if (containsAnnotation && !CheckUtil.isPackageInfo(getFilePath())) {
log(ast, MSG_KEY);
}
}
}