1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
|
20 | |
package com.puppycrawl.tools.checkstyle.checks.coding; |
21 | |
|
22 | |
import antlr.collections.AST; |
23 | |
import com.google.common.collect.Maps; |
24 | |
import com.google.common.collect.Sets; |
25 | |
import com.puppycrawl.tools.checkstyle.api.Check; |
26 | |
import com.puppycrawl.tools.checkstyle.api.DetailAST; |
27 | |
import com.puppycrawl.tools.checkstyle.api.TokenTypes; |
28 | |
import java.util.Map; |
29 | |
import java.util.Set; |
30 | |
|
31 | |
|
32 | |
|
33 | |
|
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
|
41 | |
|
42 | |
|
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
|
48 | |
|
49 | 1 | public class EqualsHashCodeCheck |
50 | |
extends Check |
51 | |
{ |
52 | |
|
53 | |
|
54 | |
|
55 | |
|
56 | 1 | private final Map<DetailAST, DetailAST> mObjBlockEquals = Maps.newHashMap(); |
57 | |
|
58 | |
|
59 | 1 | private final Set<DetailAST> mObjBlockWithHashCode = Sets.newHashSet(); |
60 | |
|
61 | |
@Override |
62 | |
public int[] getDefaultTokens() |
63 | |
{ |
64 | 1 | return new int[] {TokenTypes.METHOD_DEF}; |
65 | |
} |
66 | |
|
67 | |
@Override |
68 | |
public void beginTree(DetailAST aRootAST) |
69 | |
{ |
70 | 1 | mObjBlockEquals.clear(); |
71 | 1 | mObjBlockWithHashCode.clear(); |
72 | 1 | } |
73 | |
|
74 | |
@Override |
75 | |
public void visitToken(DetailAST aAST) |
76 | |
{ |
77 | 13 | final DetailAST modifiers = aAST.getFirstChild(); |
78 | 13 | final AST type = aAST.findFirstToken(TokenTypes.TYPE); |
79 | 13 | final AST methodName = aAST.findFirstToken(TokenTypes.IDENT); |
80 | 13 | final DetailAST parameters = aAST.findFirstToken(TokenTypes.PARAMETERS); |
81 | |
|
82 | 13 | if ((type.getFirstChild().getType() == TokenTypes.LITERAL_BOOLEAN) |
83 | |
&& "equals".equals(methodName.getText()) |
84 | |
&& modifiers.branchContains(TokenTypes.LITERAL_PUBLIC) |
85 | |
&& (parameters.getChildCount() == 1) |
86 | |
&& isObjectParam(parameters.getFirstChild()) |
87 | |
) |
88 | |
{ |
89 | 5 | mObjBlockEquals.put(aAST.getParent(), aAST); |
90 | |
} |
91 | 8 | else if ((type.getFirstChild().getType() == TokenTypes.LITERAL_INT) |
92 | |
&& "hashCode".equals(methodName.getText()) |
93 | |
&& modifiers.branchContains(TokenTypes.LITERAL_PUBLIC) |
94 | |
&& (parameters.getFirstChild() == null)) |
95 | |
{ |
96 | 2 | mObjBlockWithHashCode.add(aAST.getParent()); |
97 | |
} |
98 | 13 | } |
99 | |
|
100 | |
|
101 | |
|
102 | |
|
103 | |
|
104 | |
|
105 | |
private boolean isObjectParam(AST aFirstChild) |
106 | |
{ |
107 | 7 | final AST modifiers = aFirstChild.getFirstChild(); |
108 | 7 | final AST type = modifiers.getNextSibling(); |
109 | 7 | switch (type.getFirstChild().getType()) { |
110 | |
case TokenTypes.LITERAL_BOOLEAN: |
111 | |
case TokenTypes.LITERAL_BYTE: |
112 | |
case TokenTypes.LITERAL_CHAR: |
113 | |
case TokenTypes.LITERAL_DOUBLE: |
114 | |
case TokenTypes.LITERAL_FLOAT: |
115 | |
case TokenTypes.LITERAL_INT: |
116 | |
case TokenTypes.LITERAL_LONG: |
117 | |
case TokenTypes.LITERAL_SHORT: |
118 | 2 | return false; |
119 | |
default: |
120 | 5 | return true; |
121 | |
} |
122 | |
} |
123 | |
|
124 | |
@Override |
125 | |
public void finishTree(DetailAST aRootAST) |
126 | |
{ |
127 | 1 | final Set<DetailAST> equalsDefs = mObjBlockEquals.keySet(); |
128 | 1 | for (DetailAST objBlock : equalsDefs) { |
129 | 5 | if (!mObjBlockWithHashCode.contains(objBlock)) { |
130 | 3 | final DetailAST equalsAST = mObjBlockEquals.get(objBlock); |
131 | 3 | log(equalsAST.getLineNo(), equalsAST.getColumnNo(), |
132 | |
"equals.noHashCode"); |
133 | 5 | } |
134 | |
} |
135 | |
|
136 | 1 | mObjBlockEquals.clear(); |
137 | 1 | mObjBlockWithHashCode.clear(); |
138 | 1 | } |
139 | |
} |