1
+ <?xml version =" 1.0" ?>
2
+ <!--
3
+ ~ Password Management Servlets (PWM)
4
+ ~ http://www.pwm-project.org
5
+ ~
6
+ ~ Copyright (c) 2006-2009 Novell, Inc.
7
+ ~ Copyright (c) 2009-2016 The PWM Project
8
+ ~
9
+ ~ This program is free software; you can redistribute it and/or modify
10
+ ~ it under the terms of the GNU General Public License as published by
11
+ ~ the Free Software Foundation; either version 2 of the License, or
12
+ ~ (at your option) any later version.
13
+ ~
14
+ ~ This program is distributed in the hope that it will be useful,
15
+ ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
16
+ ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
+ ~ GNU General Public License for more details.
18
+ ~
19
+ ~ You should have received a copy of the GNU General Public License
20
+ ~ along with this program; if not, write to the Free Software
21
+ ~ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
+ -->
23
+
24
+ <!DOCTYPE module PUBLIC
25
+ "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
26
+ "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
27
+
28
+ <!--
29
+ PWM Checkstyle definition
30
+ -->
31
+
32
+ <module name =" Checker" >
33
+
34
+ <!-- Checks that each Java package has a Javadoc file used for commenting. -->
35
+ <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
36
+ <!-- module name="JavadocPackage">
37
+ <property name="allowLegacy" value="true"/>
38
+ </module-->
39
+
40
+ <module name =" FileLength" />
41
+
42
+ <!-- Checks for Headers -->
43
+ <!-- See http://checkstyle.sf.net/config_header.html -->
44
+ <!--
45
+ <module name="RegexpHeader">
46
+ <property name="fileExtensions" value="java"/>
47
+ <property name="headerFile" value="${checkstyle.header.file}"/>
48
+ </module>
49
+ -->
50
+
51
+ <module name =" FileTabCharacter" >
52
+ <property name =" eachLine" value =" true" />
53
+ </module >
54
+ <module name =" NewlineAtEndOfFile" />
55
+
56
+ <module name =" TreeWalker" >
57
+
58
+ <property name =" cacheFile" value =" target/checkstyle.cache" />
59
+
60
+ <!-- required for SuppressWarningsFilter (and other Suppress* rules not used here) -->
61
+ <!-- see http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarningsHolder -->
62
+ <module name =" SuppressWarningsHolder" />
63
+
64
+ <module name =" OuterTypeFilename" />
65
+ <module name =" IllegalTokenText" >
66
+ <property name =" tokens" value =" STRING_LITERAL, CHAR_LITERAL" />
67
+ <property name =" format" value =" \\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
68
+ <property name =" message" value =" Avoid using corresponding octal or Unicode escape." />
69
+ </module >
70
+ <module name =" AvoidEscapedUnicodeCharacters" >
71
+ <property name =" allowEscapesForControlCharacters" value =" true" />
72
+ <property name =" allowByTailComment" value =" true" />
73
+ <property name =" allowNonPrintableEscapes" value =" true" />
74
+ </module >
75
+
76
+ <!--
77
+ <module name="LineLength">
78
+ <property name="max" value="200" />
79
+ <property name="ignorePattern" value="@version|@see|@todo|TODO"/>
80
+ </module>
81
+ -->
82
+ <!-- required for SuppressionCommentFilter -->
83
+ <!-- see http://checkstyle.sourceforge.net/config.html#SuppressionCommentFilter -->
84
+ <!--
85
+ <module name="FileContentsHolder"/>
86
+
87
+
88
+ -->
89
+
90
+ <module name =" EmptyBlock" >
91
+ <property name =" option" value =" TEXT" />
92
+ <property name =" tokens" value =" LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
93
+ </module >
94
+ <!--
95
+ <module name="LeftCurly">
96
+ <property name="option" value="nl"/>
97
+ <property name="maxLineLength" value="100"/>
98
+ </module>
99
+ -->
100
+
101
+ <module name =" RightCurly" />
102
+ <module name =" RightCurly" >
103
+ <property name =" option" value =" alone" />
104
+ <property name =" tokens" value =" CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT" />
105
+ </module >
106
+
107
+ <!--
108
+ <module name="MemberName" />
109
+ -->
110
+
111
+ <!-- Checks for Javadoc comments. -->
112
+ <!-- See http://checkstyle.sf.net/config_javadoc.html -->
113
+ <!--
114
+ <module name="JavadocMethod">
115
+ <property name="severity" value="warning"/>
116
+ <property name="scope" value="protected"/>
117
+ </module>
118
+ <module name="JavadocType">
119
+ <property name="scope" value="protected"/>
120
+ <property name="allowUnknownTags" value="true" />
121
+ </module>
122
+ <module name="JavadocVariable">
123
+ <property name="severity" value="info"/>
124
+ <property name="scope" value="protected"/>
125
+ </module>
126
+ -->
127
+
128
+ <module name =" AnnotationLocation" >
129
+ <property name =" tokens" value =" VARIABLE_DEF" />
130
+ <property name =" allowSamelineMultipleAnnotations" value =" true" />
131
+ </module >
132
+
133
+ <!-- Checks for Naming Conventions. -->
134
+ <!-- See http://checkstyle.sf.net/config_naming.html -->
135
+ <!--
136
+ <module name="MemberName">
137
+ <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
138
+ </module>
139
+ <module name="TypeName">
140
+ -->
141
+ <module name =" ConstantName" />
142
+ <module name =" PackageName" >
143
+ <property name =" format" value =" ^[a-z]+(\.[a-z][a-z0-9]*)*$" />
144
+ </module >
145
+ <module name =" LocalVariableName" >
146
+ <property name =" tokens" value =" VARIABLE_DEF" />
147
+ <property name =" format" value =" ^[a-z][a-z0-9][a-zA-Z0-9]*$" />
148
+ <property name =" allowOneCharVarInForLoop" value =" true" />
149
+ </module >
150
+ <!--
151
+ <module name="ClassTypeParameterName">
152
+ <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
153
+ </module>
154
+ -->
155
+ <module name =" MethodTypeParameterName" >
156
+ <property name =" format" value =" (^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
157
+ </module >
158
+ <module name =" InterfaceTypeParameterName" >
159
+ <property name =" format" value =" (^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
160
+ </module >
161
+ <!--
162
+ <module name="LocalFinalVariableName"/>
163
+ <module name="LocalVariableName"/>
164
+ <module name="MethodName"/>
165
+ <module name="PackageName"/>
166
+ <module name="ParameterName"/>
167
+ <module name="StaticVariableName"/>
168
+ <module name="TypeName"/>
169
+ -->
170
+
171
+ <!-- Checks for imports -->
172
+ <!-- See http://checkstyle.sf.net/config_import.html -->
173
+ <module name =" AvoidStarImport" />
174
+ <module name =" AvoidStaticImport" />
175
+ <module name =" IllegalImport" />
176
+ <module name =" RedundantImport" />
177
+ <module name =" UnusedImports" />
178
+
179
+
180
+ <!-- Checks for Size Violations. -->
181
+ <!-- See http://checkstyle.sf.net/config_sizes.html -->
182
+ <!--
183
+ <module name="MethodLength"/>
184
+ <module name="ParameterNumber"/>
185
+ -->
186
+
187
+
188
+ <!-- Checks for whitespace -->
189
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
190
+ <module name =" EmptyForIteratorPad" >
191
+ <property name =" option" value =" space" />
192
+ </module >
193
+ <module name =" EmptyForInitializerPad" />
194
+ <module name =" NeedBraces" />
195
+ <!--
196
+ -->
197
+ <!-- module name="NoWhitespaceAfter"/ -->
198
+ <!-- module name="NoWhitespaceBefore"/ -->
199
+ <!--
200
+ <module name="OperatorWrap"/>
201
+ <module name="ParenPad">
202
+ <property name="option" value="space" />
203
+ </module>
204
+ <module name="WhitespaceAfter"/>
205
+ <module name="WhitespaceAround"/>
206
+ -->
207
+ <!-- module name="MethodParamPad"/ -->
208
+ <module name =" GenericWhitespace" />
209
+ <module name =" EmptyLineSeparator" >
210
+ <property name =" allowNoEmptyLineBetweenFields" value =" true" />
211
+ </module >
212
+
213
+
214
+
215
+ <!-- Modifier Checks -->
216
+ <!-- See http://checkstyle.sf.net/config_modifiers.html -->
217
+ <module name =" ModifierOrder" />
218
+ <module name =" RedundantModifier" />
219
+ <!--
220
+ -->
221
+
222
+
223
+ <!-- Checks for blocks. You know, those {}'s -->
224
+ <!-- See http://checkstyle.sf.net/config_blocks.html -->
225
+ <!--
226
+ <module name="AvoidNestedBlocks"/>
227
+ -->
228
+
229
+
230
+ <!-- Checks for common coding problems -->
231
+ <!-- See http://checkstyle.sf.net/config_coding.html -->
232
+ <!-- module name="AvoidInlineConditionals"/ -->
233
+ <!--
234
+ <module name="EmptyStatement"/>
235
+ <module name="EqualsHashCode"/>
236
+ <module name="HiddenField">
237
+ <property name="severity" value="warning"/>
238
+ <property name="ignoreSetter" value="true"/>
239
+ <property name="ignoreConstructorParameter" value="true"/>
240
+ </module>
241
+ <module name="IllegalInstantiation"/>
242
+ <module name="InnerAssignment"/>
243
+ -->
244
+ <!--
245
+ <module name="MagicNumber">
246
+ <property name="ignoreNumbers" value="-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 31, 32, 37, 64, 100, 128, 256, 512, 1000, 1024"/>
247
+ </module>
248
+ -->
249
+
250
+ <!-- Checks for class design -->
251
+ <!-- See http://checkstyle.sf.net/config_design.html -->
252
+ <!-- module name="DesignForExtension"/ -->
253
+ <!-- module name="FinalClass"/ -->
254
+ <!-- module name="HideUtilityClassConstructor"/ -->
255
+ <!--
256
+ <module name="InterfaceIsType"/>
257
+ <module name="VisibilityModifier">
258
+ <property name="protectedAllowed" value="true"/>
259
+ <property name="packageAllowed" value="true"/>
260
+ </module>
261
+ -->
262
+
263
+
264
+ <!-- future enabled checks -->
265
+ <!--
266
+ <module name="TrailingComment"/>
267
+ <module name="NPathComplexity"/>
268
+ <module name="EnumTrailingCommaCheck"/> //doesnt yet exist as of checkstyle 2.17
269
+ <module name="MultipleStringLiterals"/>
270
+ <module name="InnerAssignment"/>
271
+ <module name="MagicNumber">
272
+ <property name="ignoreNumbers" value="-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 31, 32, 37, 64, 100, 128, 256, 512, 1000, 1024"/>
273
+ </module>
274
+ <module name="SimplifyBooleanExpression"/>
275
+ -->
276
+
277
+ <!-- coding -->
278
+ <module name =" FallThrough" />
279
+ <module name =" EqualsHashCode" />
280
+ <module name =" ArrayTrailingCommaCheck" />
281
+ <module name =" FinalLocalVariable" />
282
+ <module name =" MissingSwitchDefault" />
283
+ <module name =" ModifiedControlVariable" />
284
+ <module name =" MultipleVariableDeclarations" />
285
+ <module name =" OneStatementPerLine" />
286
+ <module name =" FinalParameters" />
287
+ <module name =" ParameterAssignment" />
288
+ <module name =" SimplifyBooleanReturn" />
289
+ <module name =" StringLiteralEquality" />
290
+ <module name =" CovariantEquals" />
291
+ <module name =" DefaultComesLast" />
292
+ <module name =" EmptyStatement" />
293
+ <module name =" EqualsHashCode" />
294
+ <module name =" EqualsAvoidNull" />
295
+
296
+ <module name =" MutableException" />
297
+ <module name =" TodoComment" />
298
+ <module name =" NoLineWrap" />
299
+ <module name =" OneTopLevelClass" />
300
+ <module name =" NoFinalizer" />
301
+ <module name =" ArrayTypeStyle" />
302
+ <module name =" UpperEll" />
303
+ <module name =" PackageDeclaration" />
304
+ <module name =" NoClone" />
305
+ </module >
306
+
307
+ <!-- Support @SuppressWarnings (added in Checkstyle 5.7) -->
308
+ <!-- see http://checkstyle.sourceforge.net/config.html#SuppressWarningsFilter -->
309
+ <module name =" SuppressWarningsFilter" />
310
+
311
+ <!-- Checks properties file for a duplicated properties. -->
312
+ <!-- See http://checkstyle.sourceforge.net/config_misc.html#UniqueProperties -->
313
+ <module name =" UniqueProperties" />
314
+
315
+ <!-- Support CHECKSTYLE_OFF: regexp and CHECKSTYLE_ON: regexp comments to disable/enable some checks -->
316
+ <!-- see http://checkstyle.sourceforge.net/config.html#SuppressionCommentFilter -->
317
+ <!--
318
+ <module name="SuppressionCommentFilter">
319
+ <property name="offCommentFormat" value="CHECKSTYLE_OFF\: (.+)"/>
320
+ <property name="onCommentFormat" value="CHECKSTYLE_ON\: (.+)"/>
321
+ <property name="checkFormat" value="$1"/>
322
+ </module>
323
+ -->
324
+
325
+ </module >
0 commit comments