forked from hortonworks/cloudbreak
-
Notifications
You must be signed in to change notification settings - Fork 5
/
checkstyle.xml
328 lines (311 loc) · 14.1 KB
/
checkstyle.xml
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<property name="severity" value="error" />
<module name="TreeWalker">
<property name="tabWidth" value="4" />
<!-- Format -->
<module name="EmptyForIteratorPad" />
<module name="EmptyForInitializerPad" />
<module name="EmptyLineSeparator">
<property name="allowMultipleEmptyLines" value="false" />
<property name="tokens" value="PACKAGE_DEF, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
</module>
<module name="MethodParamPad" />
<module name="NoWhitespaceAfter">
<property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS" />
</module>
<module name="NoWhitespaceBefore" />
<module name="OperatorWrap" />
<module name="ParenPad" />
<module name="TypecastParenPad" />
<module name="WhitespaceAfter" />
<module name="WhitespaceAround" />
<module name="GenericWhitespace" />
<module name="LeftCurly" />
<module name="NeedBraces" />
<module name="RightCurly" />
<module name="LineLength">
<!-- more? 160 should be okay -->
<!-- n+1, because eclipse formatter tends to format for +1 length :) -->
<property name="max" value="161" />
</module>
<module name="PackageDeclaration" />
<!-- -->
<!-- Naming -->
<module name="PackageName">
<property name="format" value="^com\.sequenceiq(\.[a-z0-9]{2,16})+$" />
</module>
<module name="TypeName" />
<module name="ClassTypeParameterName" />
<module name="AbstractClassName">
<property name="format" value="^Abstract.*$" />
<property name="ignoreName" value="true" />
</module>
<module name="ConstantName" />
<module name="StaticVariableName" />
<module name="MemberName" />
<module name="MethodName" />
<module name="MethodTypeParameterName" />
<module name="ParameterName" />
<module name="LocalFinalVariableName" />
<module name="LocalVariableName" />
<!-- -->
<!-- Javadoc
<module name="JavadocMethod">
<property name="scope" value="protected" />
<property name="allowUndeclaredRTE" value="true" />
<property name="allowMissingParamTags" value="true" />
<property name="allowMissingThrowsTags" value="true" />
<property name="allowMissingReturnTag" value="true" />
<property name="allowMissingPropertyJavadoc" value="true" />
<property name="suppressLoadErrors" value="true" />
<property name="tokens" value="METHOD_DEF" />
</module>
<module name="JavadocType">
<property name="scope" value="package" />
</module>
<module name="JavadocVariable">
<property name="scope" value="protected" />
</module>
<module name="JavadocStyle">
<property name="checkEmptyJavadoc" value="true" />
</module>
-->
<!-- Metrics -->
<module name="ParameterNumber">
<property name="max" value="7" />
<property name="tokens" value="METHOD_DEF" />
</module>
<module name="CyclomaticComplexity">
<property name="max" value="10" />
<!-- property name="switchBlockAsSingleDecisionPoint" value="true" / -->
</module>
<module name="NPathComplexity">
<property name="max" value="256" />
</module>
<!-- -->
<!-- Style -->
<module name="ModifierOrder" />
<module name="VisibilityModifier" />
<module name="InterfaceIsType" />
<!--<module name="HiddenField">
<property name="ignoreConstructorParameter" value="true" />
<property name="ignoreSetter" value="true" />
<property name="ignoreAbstractMethods" value="true" />
</module> -->
<module name="UpperEll" />
<module name="ArrayTypeStyle" />
<module name="DeclarationOrder" />
<module name="MultipleVariableDeclarations" />
<module name="StringLiteralEquality" />
<module name="InnerTypeLast" />
<module name="EqualsAvoidNull" />
<module name="DefaultComesLast" />
<module name="OneStatementPerLine" />
<module name="CovariantEquals" />
<module name="TrailingComment" />
<module name="FallThrough" />
<module name="OuterTypeNumber" />
<module name="SuperClone" />
<module name="MutableException" />
<module name="AvoidStarImport" />
<module name="PackageAnnotation" />
<!-- -->
<!-- Redundancy -->
<module name="EmptyBlock" />
<module name="EmptyStatement" />
<module name="RedundantModifier" />
<module name="ExplicitInitialization" />
<module name="Regexp">
<property name="format" value="\bsuper\(\);" />
<property name="message" value="Remove unnecessary super default constructor call." />
<property name="illegalPattern" value="true" />
<property name="ignoreComments" value="true" />
</module>
<module name="Regexp">
<property name="format" value="Auto-generated|non-Javadoc" />
<property name="message" value="Remove auto-generated comments." />
<property name="illegalPattern" value="true" />
</module>
<module name="UnnecessaryParentheses" />
<module name="RedundantImport" />
<module name="UnusedImports" />
<module name="SimplifyBooleanExpression" />
<module name="SimplifyBooleanReturn" />
<!-- -->
<!-- Deprecations -->
<module name="AvoidNestedBlocks" />
<module name="EqualsHashCode" />
<module name="ModifiedControlVariable" />
<module name="InnerAssignment" />
<module name="MagicNumber">
<property name="ignoreHashCodeMethod" value="true" />
<property name="ignoreAnnotation" value="true" />
</module>
<module name="NoFinalizer" />
<module name="IllegalInstantiation">
<!-- use valueOf() -->
<property name="classes" value="java.lang.Boolean,java.lang.Integer,java.lang.Long,java.lang.Float,java.lang.Double" />
</module>
<module name="IllegalInstantiation">
<!-- use alternative classes -->
<property name="classes" value="java.util.Vector" />
</module>
<module name="IllegalInstantiation">
<property name="id" value="hashtable-instantiation"/>
<!-- use alternative classes -->
<property name="classes" value="java.util.Hashtable" />
</module>
<module name="IllegalThrows" />
<module name="IllegalCatch">
<property name="illegalClassNames" value="java.lang.IllegalStateException, java.lang.IllegalArgumentException" />
</module>
<module name="IllegalType">
<property name="format" value="^$" />
</module>
<module name="IllegalType">
<property name="id" value="IllegalTypeImpl"/>
<property name="format" value="^(Abstract.*|.*Impl)$" />
<property name="illegalClassNames" value="" />
</module>
<module name="IllegalImport">
<!-- use org.slf4j -->
<property name="illegalPkgs" value="sun, org.apache.commons.logging, org.apache.log4j, java.util.logging" />
</module>
<module name="IllegalImport">
<!-- use org.junit -->
<property name="illegalPkgs" value="junit.framework" />
</module>
<module name="IllegalImport">
<!-- use mockito -->
<property name="illegalPkgs" value="org.easymock" />
</module>
<module name="IllegalImport">
<!-- use lang3 -->
<property name="illegalPkgs" value="org.apache.commons.lang" />
</module>
<module name="IllegalImport">
<!-- deprecated lib -->
<property name="illegalPkgs" value="org.apache.commons.collections" />
</module>
<!-- -->
<!-- Missing code -->
<module name="HideUtilityClassConstructor" />
<module name="MissingOverride" />
<module name="MissingDeprecated" />
<module name="MissingSwitchDefault" />
<!-- -->
<!-- Makes suppression comments available -->
<module name="FileContentsHolder" />
</module>
<!-- Deprecation -->
<module name="RegexpMultiline">
<property name="id" value="sysout" />
<property name="format" value="System\s*\.\s*(out|err)" />
<property name="message" value="Avoid writing directly to the console. Use logger." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpMultiline">
<property name="format" value="System\s*\.\s*(exit)" />
<property name="message" value="Do not mess with JVM." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpMultiline">
<property name="id" value="printTrace" />
<property name="format" value="\.printStackTrace\(\)" />
<property name="message" value="Avoid printing exception stack-trace onto console. Use logger or re-throw (in a wrapper)." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpMultiline">
<property name="format" value="catch \(\w+ \w+\) \{\s*(Assert\s*\.)?\s*(fail\(|assertNotNull\(\w+\))" />
<property name="message" value="Unnecessary catch. Add "throws" to test method." />
<property name="fileExtensions" value="java" />
</module>
<!-- -->
<!-- Format -->
<module name="FileTabCharacter">
<property name="eachLine" value="true" />
<property name="fileExtensions" value="java,xml,properties" />
</module>
<module name="Translation" />
<module name="RegexpSingleline">
<property name="format" value="(?<!^\s+\*)\s+$"/>
<property name="message" value="Line has trailing spaces." />
<property name="fileExtensions" value="java,xml,properties" />
</module>
<module name="RegexpSingleline">
<property name="format" value="^( )* {1,3}[^ *]" />
<property name="message" value="Indentation problem." />
<property name="fileExtensions" value="java,xml" />
</module>
<module name="RegexpMultiline">
<property name="format" value="\* (@return|@param <?\w+>?|@throws \w+)\r?\n" />
<property name="message" value="Empty javadoc item. Either delete or describe." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpMultiline">
<property name="format" value="([a-zA-Z0-9]+) = ((?!\1).)*?;(\r?\n)+ *return \1;" />
<property name="message" value="Unnecessary local variable." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpSingleline">
<property name="format" value="(?<!\.)this\.\w+\(" />
<property name="message" value="Do not use "this" for method calls." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpSingleline">
<property name="format" value="[Bb]oolean is[A-Z]\w+\b(?!\()" />
<property name="message" value="Boolean variables should not be prefixed with "is"." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpSingleline">
<property name="format" value="interface I[A-Z]\w+\b" />
<property name="message" value="Interfaces should not be prefixed with "I"." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpSingleline">
<property name="format" value="(i?)class \w+DTO\b" />
<property name="message" value="Classes should not be suffixed with "DTO"." />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpHeader">
<property name="header" value="^package.*" />
<property name="fileExtensions" value="java" />
</module>
<!-- -->
<!-- Deprecation -->
<module name="RegexpSingleline">
<property name="format" value="@SuppressWarnings\(.*"deprecation"" />
<property name="message" value="Deprecation warning must not be suppressed. API is deprecated for reason!" />
<property name="fileExtensions" value="java" />
</module>
<module name="RegexpSingleline">
<property name="format" value="return "jsonfeedtemplate"" />
<property name="message" value="This view is deprecated. Use @ResponseBody annotation and return a POJO or Map<String, Object> of values." />
<property name="fileExtensions" value="java" />
</module>
<!-- Metrics -->
<module name="FileLength">
<property name="fileExtensions" value="java,xml,properties" />
</module>
<!-- -->
<!-- Suppressions -->
<module name="SuppressionCommentFilter">
<!-- javadoc is not required for enum items -->
<property name="offCommentFormat" value="ENUM ITEMS START" />
<property name="onCommentFormat" value="ENUM ITEMS END" />
<property name="checkFormat" value="JavadocVariable" />
</module>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="BEGIN GENERATED CODE"/>
<property name="onCommentFormat" value="END GENERATED CODE"/>
</module>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE:OFF"/>
<property name="onCommentFormat" value="CHECKSTYLE:ON"/>
</module>
<module name="SuppressionFilter">
<property name="file" value="${config_loc}/checkstyle-suppressions.xml" />
</module>
</module>