/
OverloadMethodsDeclarationOrderCheck.java
130 lines (116 loc) · 4.58 KB
/
OverloadMethodsDeclarationOrderCheck.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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2024 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.coding;
import java.util.HashMap;
import java.util.Map;
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.TokenUtil;
/**
* <p>
* Checks that overloaded methods are grouped together. Overloaded methods have the same
* name but different signatures where the signature can differ by the number of
* input parameters or type of input parameters or both.
* </p>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code overload.methods.declaration}
* </li>
* </ul>
*
* @since 5.8
*/
@StatelessCheck
public class OverloadMethodsDeclarationOrderCheck extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "overload.methods.declaration";
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {
TokenTypes.OBJBLOCK,
};
}
@Override
public void visitToken(DetailAST ast) {
final int parentType = ast.getParent().getType();
final int[] tokenTypes = {
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.LITERAL_NEW,
TokenTypes.RECORD_DEF,
};
if (TokenUtil.isOfType(parentType, tokenTypes)) {
checkOverloadMethodsGrouping(ast);
}
}
/**
* Checks that if overload methods are grouped together they should not be
* separated from each other.
*
* @param objectBlock
* is a class, interface or enum object block.
*/
private void checkOverloadMethodsGrouping(DetailAST objectBlock) {
final int allowedDistance = 1;
DetailAST currentToken = objectBlock.getFirstChild();
final Map<String, Integer> methodIndexMap = new HashMap<>();
final Map<String, Integer> methodLineNumberMap = new HashMap<>();
int currentIndex = 0;
while (currentToken != null) {
if (currentToken.getType() == TokenTypes.METHOD_DEF) {
currentIndex++;
final String methodName =
currentToken.findFirstToken(TokenTypes.IDENT).getText();
final Integer previousIndex = methodIndexMap.get(methodName);
final DetailAST previousSibling = currentToken.getPreviousSibling();
final boolean isMethod = previousSibling.getType() == TokenTypes.METHOD_DEF;
if (previousIndex != null
&& (!isMethod || currentIndex - previousIndex > allowedDistance)) {
final int previousLineWithOverloadMethod =
methodLineNumberMap.get(methodName);
log(currentToken, MSG_KEY,
previousLineWithOverloadMethod);
}
methodIndexMap.put(methodName, currentIndex);
methodLineNumberMap.put(methodName, currentToken.getLineNo());
}
currentToken = currentToken.getNextSibling();
}
}
}