Skip to content

Commit 5f73d92

Browse files
sebersolesebersole
committed
HHH-9803 - Checkstyle fix ups
1 parent 4b3a655 commit 5f73d92

File tree

1 file changed

+107
-122
lines changed

1 file changed

+107
-122
lines changed

‎shared/config/checkstyle/checkstyle.xml

Lines changed: 107 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -25,215 +25,200 @@
2525
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
2626
<module name="Checker">
2727

28+
<!-- See http://checkstyle.sourceforge.net/checks.html for details of the various checks -->
29+
2830
<module name="TreeWalker">
2931

3032
<!--
31-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32-
General regex checks as part of the TreeWalker
33-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33+
High-priority warnings : fail the build...
3434
-->
3535
<module name="RegexpSinglelineJava">
3636
<property name="ignoreComments" value="true" />
3737
<property name="format" value="^\t* +\t*\S" />
3838
<property name="message" value="Line has leading space characters; indentation should be performed with tabs only." />
3939
</module>
4040

41-
42-
<!--
43-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44-
Annotation checks
45-
46-
See http://checkstyle.sourceforge.net/config_annotation.html
47-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48-
-->
4941
<module name="MissingDeprecated" />
50-
<module name="MissingOverride" />
51-
<module name="PackageAnnotation" />
5242

43+
<module name="MissingOverride" />
5344

54-
<!--
55-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56-
Block checks
45+
<module name="PackageAnnotation" />
5746

58-
See http://checkstyle.sourceforge.net/config_blocks.html
59-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60-
-->
61-
<module name="AvoidNestedBlocks">
62-
<property name="allowInSwitchCase" value="true" />
63-
<property name="severity" value="warning" />
64-
</module>
6547
<module name="NeedBraces" />
48+
6649
<module name="LeftCurly">
6750
<property name="option" value="eol" />
6851
</module>
52+
6953
<module name="RightCurly">
7054
<property name="option" value="alone" />
7155
</module>
7256

57+
<module name="EqualsHashCode" />
58+
59+
<module name="StringLiteralEquality" />
60+
61+
<module name="NoFinalizer" />
62+
63+
<module name="OneStatementPerLine" />
64+
65+
<module name="AvoidStarImport" />
66+
67+
<module name="RedundantImport" />
68+
69+
<module name="UnusedImports" />
70+
71+
<module name="UpperEll" />
72+
7373

74-
<!--
75-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76-
Design checks
7774

78-
See http://checkstyle.sourceforge.net/config_design.html
79-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75+
<!--
76+
Medium and low priority warnings : do not fail build
8077
-->
81-
<module name="HideUtilityClassConstructor">
82-
<!-- Some classes in o.h.metamodel on master do this -->
78+
79+
<module name="AvoidNestedBlocks">
80+
<property name="allowInSwitchCase" value="true" />
8381
<property name="severity" value="warning" />
8482
</module>
85-
<module name="MutableException" />
8683

84+
<module name="HideUtilityClassConstructor">
85+
<property name="severity" value="warning" />
86+
</module>
8787

88-
<!--
89-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90-
Coding checks
88+
<module name="MutableException">
89+
<property name="severity" value="warning" />
90+
</module>
9191

92-
See http://checkstyle.sourceforge.net/config_coding.html
93-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94-
-->
9592
<module name="EmptyStatement">
9693
<property name="severity" value="warning" />
9794
</module>
98-
<module name="EqualsHashCode" />
99-
<!--
100-
<module name="FinalLocalVariable">
95+
96+
<module name="MissingSwitchDefault">
10197
<property name="severity" value="warning" />
10298
</module>
103-
-->
104-
<module name="MissingSwitchDefault">
99+
100+
<module name="DefaultComesLast">
105101
<property name="severity" value="warning" />
106102
</module>
107-
<module name="DefaultComesLast" />
103+
108104
<module name="ModifiedControlVariable">
109105
<property name="severity" value="warning" />
110106
</module>
111-
<module name="SimplifyBooleanExpression" />
112-
<module name="SimplifyBooleanReturn" />
113-
<module name="StringLiteralEquality" />
114-
<module name="NoFinalizer" />
115-
<module name="ExplicitInitialization">
107+
108+
<module name="SimplifyBooleanExpression">
116109
<property name="severity" value="warning" />
117110
</module>
118-
<module name="FallThrough" />
119-
<module name="OneStatementPerLine" />
120111

112+
<module name="SimplifyBooleanReturn">
113+
<property name="severity" value="warning" />
114+
</module>
121115

122-
<!--
123-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124-
Import checks
125-
126-
See http://checkstyle.sourceforge.net/config_imports.html
127-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128-
-->
129-
<module name="AvoidStarImport" />
130-
<module name="RedundantImport" />
131-
<module name="UnusedImports" />
132-
116+
<module name="ExplicitInitialization">
117+
<property name="severity" value="warning" />
118+
</module>
133119

134-
<!--
135-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136-
Misc checks
120+
<module name="FallThrough">
121+
<property name="severity" value="warning" />
122+
</module>
137123

138-
See http://checkstyle.sourceforge.net/config_misc.html
139-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140-
-->
141-
<module name="UpperEll" />
142124
<module name="ArrayTypeStyle">
143-
<!-- Some classes in o.h.metamodel on master do this -->
144125
<property name="severity" value="warning" />
145126
</module>
127+
146128
<module name="TrailingComment">
147129
<property name="severity" value="warning" />
148130
</module>
149131

132+
<module name="ModifierOrder">
133+
<property name="severity" value="warning" />
134+
</module>
150135

151-
<!--
152-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153-
Modifier checks
154-
155-
See http://checkstyle.sourceforge.net/config_modifier.html
156-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157-
-->
158-
<module name="ModifierOrder"/>
159-
160-
161-
<!--
162-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163-
Naming checks
164-
165-
See http://checkstyle.sourceforge.net/config_naming.html
166-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
167-
-->
168136
<module name="AbstractClassName">
169137
<!-- we are just using this to make sure that classes matching the pattern (Abstract*) have the abstract modifier -->
170138
<property name="format" value="^Abstract.*$" />
171139
<property name="ignoreName" value="true" />
140+
<property name="severity" value="warning" />
172141
</module>
142+
173143
<module name="ClassTypeParameterName">
174144
<property name="format" value="^[A-Z][A-Z0-9]*$" />
145+
<property name="severity" value="warning" />
175146
</module>
147+
176148
<module name="ConstantName">
177149
<property name="format" value="^[A-Z](_?[A-Z0-9]+)*$|log" />
178-
<!-- Some classes in o.h.metamodel on master violate this -->
179150
<property name="severity" value="warning" />
180151
</module>
181-
<module name="LocalFinalVariableName" />
152+
153+
<module name="LocalFinalVariableName">
154+
<property name="severity" value="warning" />
155+
</module>
156+
182157
<module name="LocalVariableName">
183-
<!-- Some classes in o.h.metamodel on master violate this -->
184158
<property name="severity" value="warning" />
185159
</module>
186-
<module name="MemberName" />
187-
<!--
188-
The org.hibernate.engine.spi.ManagedEntity method names (prefixed with '&&_') muck with this
189-
<module name="MethodName" />
190-
-->
160+
161+
<module name="MemberName">
162+
<property name="severity" value="warning" />
163+
</module>
164+
191165
<module name="MethodTypeParameterName">
192166
<property name="format" value="^[A-Z][A-Z0-9]*$" />
167+
<property name="severity" value="warning" />
193168
</module>
194-
<module name="PackageName" />
195-
<module name="ParameterName" />
196-
<module name="StaticVariableName" />
197-
<module name="TypeName" />
198169

170+
<module name="PackageName">
171+
<property name="severity" value="warning" />
172+
</module>
199173

200-
<!--
201-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202-
Whitespace checks
174+
<module name="ParameterName">
175+
<property name="severity" value="warning" />
176+
</module>
177+
178+
<module name="StaticVariableName">
179+
<property name="severity" value="warning" />
180+
</module>
181+
182+
<module name="TypeName">
183+
<property name="severity" value="warning" />
184+
</module>
185+
186+
<module name="AbbreviationAsWordInName">
187+
<property name="severity" value="warning" />
188+
<property name="ignoreOverriddenMethod" value="true" />
189+
</module>
190+
191+
<module name="MethodParamPad">
192+
<property name="severity" value="warning" />
193+
</module>
194+
195+
<module name="TypecastParenPad">
196+
<property name="severity" value="warning" />
197+
</module>
203198

204-
See http://checkstyle.sourceforge.net/config_whitespace.html
205-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
206-
-->
207-
<module name="MethodParamPad" />
208-
<module name="TypecastParenPad" />
209199
<module name="ParenPad">
210200
<property name="tokens" value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL" />
211201
<property name="option" value="space" />
202+
<property name="severity" value="warning" />
212203
</module>
213204

214205
</module>
215206

216-
217-
<!--
218-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
219-
Javadoc checks
220-
221-
See http://checkstyle.sourceforge.net/config_javadoc.html
222-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
223-
-->
224-
<!--
225207
<module name="JavadocPackage">
226208
<property name="allowLegacy" value="true" />
209+
<property name="severity" value="warning" />
227210
</module>
228-
-->
229211

230-
<!--
231-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
232-
Misc checks
212+
<module name="NewlineAtEndOfFile" />
233213

234-
See http://checkstyle.sourceforge.net/config_misc.html
235-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
214+
<!--
215+
Used to collect "todo" comments into a single location
236216
-->
237-
<module name="NewlineAtEndOfFile" />
217+
<module name="TreeWalker">
218+
<module name="TodoComment">
219+
<property name="format" value="[Tt][Oo][Dd][Oo]"/>
220+
<property name="severity" value="info" />
221+
</module>
222+
</module>
238223

239224
</module>

0 commit comments

Comments
 (0)