-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
InnerTypeLastCheck.java
122 lines (108 loc) · 3.7 KB
/
InnerTypeLastCheck.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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2023 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.design;
import java.util.BitSet;
import com.puppycrawl.tools.checkstyle.FileStatefulCheck;
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.ScopeUtil;
import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
/**
* <p>
* Checks nested (internal) classes/interfaces are declared at the bottom of the
* primary (top-level) class after all init and static init blocks,
* method, constructor and field declarations.
* </p>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code arrangement.members.before.inner}
* </li>
* </ul>
*
* @since 5.2
*/
@FileStatefulCheck
public class InnerTypeLastCheck extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "arrangement.members.before.inner";
/** Set of class member tokens. */
private static final BitSet CLASS_MEMBER_TOKENS = TokenUtil.asBitSet(
TokenTypes.VARIABLE_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.COMPACT_CTOR_DEF
);
/** Meet a root class. */
private boolean rootClass;
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.RECORD_DEF,
};
}
@Override
public void beginTree(DetailAST rootAST) {
rootClass = true;
}
@Override
public void visitToken(DetailAST ast) {
// First root class
if (rootClass) {
rootClass = false;
}
else {
DetailAST nextSibling = ast;
while (nextSibling != null) {
if (!ScopeUtil.isInCodeBlock(ast)
&& CLASS_MEMBER_TOKENS.get(nextSibling.getType())) {
log(nextSibling, MSG_KEY);
}
nextSibling = nextSibling.getNextSibling();
}
}
}
@Override
public void leaveToken(DetailAST ast) {
if (TokenUtil.isRootNode(ast.getParent())) {
rootClass = true;
}
}
}