-
Notifications
You must be signed in to change notification settings - Fork 1
/
checkstyle.xml
1140 lines (983 loc) · 50.2 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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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">
<!-- KIEKER default is warning instead of error -->
<property name="severity" value="error" />
<!-- KIEKER Filter -->
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="NOCS" />
<property name="checkFormat" value=".*" />
<property name="influenceFormat" value="0" />
</module>
<!-- If you set the basedir property below, then all reported file names
will be relative to the specified directory. See http://checkstyle.sourceforge.net/5.x/config.html#Checker
<property name="basedir" value="${basedir}"/> <property name="localeCountry"
value=""/> JVM locale country <property name="localeLanguage" value=""/>
JVM locale language <property name="charset" value=""/> JVM file.encoding
property ! -->
<!-- !________________________________________________________________________________________
! ! D U P L I C A T E S !________________________________________________________________________________________
! -->
<!-- Performs a line-by-line comparison of all code lines and reports duplicate
code. ! -->
<!-- See http://checkstyle.sf.net/config_duplicates.html ! -->
<!-- KIEKER Does not work with headers!! <module name="StrictDuplicateCode">
<property name="min" value="12"/> <property name="fileExtensions" value=""/>
</module> -->
<!-- !________________________________________________________________________________________
! ! H E A D E R S !________________________________________________________________________________________
! -->
<!-- NOTE: You may enable zero or one of these header checks, but not both.
! -->
<!-- Checks that a source file begins with a specified header. ! -->
<!-- See http://checkstyle.sf.net/config_header.html ! -->
<!-- KIEKER ! -->
<module name="Header">
<!-- <property name="headerFile" value=""/> -->
<!-- <property name="charset" value=""/> -->
<property name="ignoreLines" value="2" />
<property name="fileExtensions" value="java" />
</module>
<!-- Checks the header of a source file against a header file that contains
a regular expression ! -->
<!-- for each line of the source header. ! -->
<!-- See http://checkstyle.sf.net/config_header.html ! -->
<!-- Default: OFF <module name="RegexpHeader"> <property name="headerFile"
value=""/> <property name="charset" value=""/> <property name="header" value=""/>
<property name="multiLines" value=""/> <property name="fileExtensions" value=""/>
</module> ! -->
<!-- !________________________________________________________________________________________
! ! J A V A D O C S !________________________________________________________________________________________
! -->
<!-- Checks that each Java package has a Javadoc file used for commenting.
! -->
<!-- See http://checkstyle.sourceforge.net/config_javadoc.html#JavadocPackage
! -->
<!-- KIEKER: OFF <module name="JavadocPackage"> <property name="severity"
value="info"/> <property name="allowLegacy" value="false"/> </module> ! -->
<!-- !________________________________________________________________________________________
! ! R E G E X P !________________________________________________________________________________________
! -->
<!-- A check for detecting that matches across multiple lines. Works with
any file type. ! -->
<!-- See http://checkstyle.sourceforge.net/config_regexp.html#RegexpMultiline
! -->
<!-- Default: OFF <module name="RegexpMultiline"> <property name="format"
value=""/> <property name="message" value=""/> <property name="ignoreCase"
value="false"/> <property name="minimum" value="0"/> <property name="maximum"
value="0"/> <property name="fileExtensions" value=""/> </module> ! -->
<!-- A check for detecting single lines that match a supplied regular expression.
Works with any file type. ! -->
<!-- See http://checkstyle.sourceforge.net/config_regexp.html#RegexpSingleline
! -->
<!-- Default: OFF <module name="RegexpSingleline"> <property name="format"
value="\s+$"/> <property name="message" value=""/> <property name="ignoreCase"
value="false"/> <property name="minimum" value="0"/> <property name="maximum"
value="0"/> <property name="fileExtensions" value=""/> </module> ! -->
<!-- !________________________________________________________________________________________
! ! M I S C E L L A N E O U S !________________________________________________________________________________________
! -->
<!-- Checks whether files end with a new line. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile ! -->
<module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="system" />
<property name="fileExtensions" value="*.*" />
</module>
<!-- Checks that property files contain the same keys. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html#Translation ! -->
<module name="Translation">
<property name="fileExtensions" value="properties" />
</module>
<!-- !________________________________________________________________________________________
! ! S I Z E V I O L A T I O N S !________________________________________________________________________________________
! -->
<!-- Checks for long source files. ! -->
<!-- See http://checkstyle.sf.net/config_sizes.html ! -->
<module name="FileLength">
<property name="max" value="2000" />
<property name="fileExtensions" value="java" />
</module>
<!-- !________________________________________________________________________________________
! ! W H I T E S P A C E !________________________________________________________________________________________
! -->
<!-- Checks that there are no tab characters ('\t') in the source code.
! -->
<!-- See http://checkstyle.sourceforge.net/config_whitespace.html#FileTabCharacter
! -->
<!-- KIEKER we use TABs <module name="FileTabCharacter"> <property name="eachLine"
value="false"/> <property name="fileExtensions" value=""/> </module> -->
<module name="TreeWalker">
<!-- KIEKER -->
<property name="tabWidth" value="4" />
<module name="FileContentsHolder" />
<!-- !________________________________________________________________________________________
! ! A N N O T A T I O N S !________________________________________________________________________________________
! -->
<!-- This check controls the usage style of annotations. ! -->
<!-- See http://checkstyle.sourceforge.net/config_annotation.html#AnnotationUseStyle
! -->
<module name="AnnotationUseStyle">
<property name="elementStyle" value="compact_no_array" />
<property name="closingParens" value="never" />
<property name="trailingArrayComma" value="never" />
</module>
<!-- Verifies that both the java.lang.Deprecated import is present and
the @deprecated Javadoc tag is present when either is present. ! -->
<!-- See http://checkstyle.sourceforge.net/config_annotation.html#MissingDeprecated
! -->
<!-- KIEKER -->
<module name="MissingDeprecated">
<property name="severity" value="info" />
</module>
<!-- Verifies that the java.lang.Override annotation is present when the
{@inheritDoc} javadoc tag is present. ! -->
<!-- See http://checkstyle.sourceforge.net/config_annotation.html#MissingOverride
! -->
<module name="MissingOverride">
<property name="javaFiveCompatibility" value="false" />
</module>
<!-- This check makes sure that all package annotations are in the package-info.java
file. ! -->
<!-- See http://checkstyle.sourceforge.net/config_annotation.html#PackageAnnotation
! -->
<module name="PackageAnnotation" />
<!-- This check allows you to specify what warnings that SuppressWarnings
is not allowed to suppress. ! -->
<!-- You can also specify a list of TokenTypes that the configured warning(s)
cannot be suppressed on. ! -->
<!-- See http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarnings
! -->
<module name="SuppressWarnings">
<property name="format" value="^$|^\s+$" />
<property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF,
ANNOTATION_FIELD_DEF, ENUM_CONSTANT_DEF, PARAMETER_DEF,
VARIABLE_DEF, METHOD_DEF, CTOR_DEF" />
</module>
<!-- !________________________________________________________________________________________
! ! B L O C K S !________________________________________________________________________________________
! -->
<!-- Finds nested blocks, i.e. blocks that are used freely in the code.
! -->
<!-- See http://checkstyle.sf.net/config_blocks.html ! -->
<!-- KIEKER allowInSwitchCase ! -->
<module name="AvoidNestedBlocks">
<property name="allowInSwitchCase" value="true" />
</module>
<!-- Checks for empty blocks. ! -->
<!-- See http://checkstyle.sf.net/config_blocks.html ! -->
<!-- KIEKER removed LITERAL_CATCH ! -->
<module name="EmptyBlock">
<property name="option" value="stmt" />
<property name="tokens"
value="LITERAL_DO,
LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF, LITERAL_FOR,
LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, STATIC_INIT" />
</module>
<!-- Checks for the placement of left curly braces ('{') for code blocks.
! -->
<!-- See http://checkstyle.sf.net/config_blocks.html ! -->
<module name="LeftCurly">
<property name="option" value="eol" />
<property name="maxLineLength" value="165" />
<property name="tokens"
value="CLASS_DEF, CTOR_DEF,
INTERFACE_DEF, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH,
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE,
METHOD_DEF" />
</module>
<!-- Checks for braces around code blocks. ! -->
<!-- See http://checkstyle.sf.net/config_blocks.html ! -->
<!-- LITERAL_ELSE, LITERAL_IF, -->
<module name="NeedBraces">
<property name="tokens"
value="LITERAL_DO, LITERAL_FOR, LITERAL_WHILE" />
</module>
<!-- Checks the placement of right curly braces ('}') for else, try, and
catch tokens. ! -->
<!-- See http://checkstyle.sf.net/config_blocks.html ! -->
<module name="RightCurly">
<property name="option" value="same" />
<property name="tokens"
value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE" />
<property name="shouldStartLine" value="true" />
</module>
<!-- !________________________________________________________________________________________
! ! C L A S S D E S I G N !________________________________________________________________________________________
! -->
<!-- Checks that classes are designed for extension. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<!-- Default: OFF <module name="DesignForExtension"/> ! -->
<!-- Checks that a class which has only private constructors is declared
as final. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<module name="FinalClass" />
<!-- Make sure that utility classes (classes that contain only static methods)
do not have a public constructor. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<module name="HideUtilityClassConstructor" />
<!-- Check nested (internal) classes/interfaces are declared at the bottom
of the class after all method and field declarations. ! -->
<!-- See http://checkstyle.sourceforge.net/config_design.html#InnerTypeLast
! -->
<module name="InnerTypeLast" />
<!-- Implements Bloch, Effective Java, Item 17 - Use Interfaces only to
define types. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<module name="InterfaceIsType">
<property name="allowMarkerInterfaces" value="true" />
</module>
<!-- Ensures that exceptions (defined as any class name conforming to some
regular expression) are immutable. ! -->
<!-- That is, have only final fields. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<module name="MutableException">
<property name="format" value="^.*Exception$|^.*Error$" />
</module>
<!-- Restricts throws statements to a specified count. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<!-- KIEKER off <module name="ThrowsCount"> <property name="max" value="1"/>
</module> ! -->
<!-- Checks visibility of class members. ! -->
<!-- See http://checkstyle.sf.net/config_design.html ! -->
<module name="VisibilityModifier">
<property name="packageAllowed" value="false" />
<property name="protectedAllowed" value="true" />
<property name="publicMemberPattern" value="^serialVersionUID$" />
</module>
<!-- !________________________________________________________________________________________
! ! C O D I N G !________________________________________________________________________________________
! -->
<!-- Checks that array initialization contains a trailing comma. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="ArrayTrailingComma" />
<!-- Detects inline conditionals. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- <module name="AvoidInlineConditionals" /> -->
<!-- Checks that classes that define a covariant equals() method also override
method equals(java.lang.Object). ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="CovariantEquals" />
<!-- Checks declaration order according to Code Conventions for the Java
Programming Language. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="DeclarationOrder">
<property name="ignoreConstructors" value="false" />
<!-- <property name="ignoreMethods" value="false"/> -->
<property name="ignoreModifiers" value="false" />
</module>
<!-- Check that the default is after all the cases in a switch statement.
! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="DefaultComesLast" />
<!-- The "double-checked locking" idiom (DCL) tries to avoid the runtime
cost of synchronization. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!--<module name="DoubleCheckedLocking"/> -->
<!-- Detects empty statements (standalone ;). ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="EmptyStatement" />
<!-- Checks that any combination of String literals with optional assignment
is on the left side of an equals() comparison. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#EqualsAvoidNull
! -->
<module name="EqualsAvoidNull" />
<!-- Checks that classes that override equals() also override hashCode().
! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="EqualsHashCode" />
<!-- Checks if any class or object member explicitly initialized to default
for its type value. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- KIEKER off <module name="ExplicitInitialization"/> ! -->
<!-- Checks for fall through in switch statements Finds locations where
a case contains Java code ... ! -->
<!-- but lacks a break, return, throw or continue statement. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="FallThrough">
<property name="checkLastCaseGroup" value="false" />
<property name="reliefPattern" value="fallthru|falls??through" />
</module>
<!-- Checks that local variables that never have their values changed are
declared final. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="FinalLocalVariable">
<property name="tokens" value="VARIABLE_DEF" />
</module>
<!-- Checks that a local variable or a parameter does not shadow a field
that is defined in the same class. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- KIEKER ignoreConstructorParameter, ignoreSetter -->
<module name="HiddenField">
<property name="tokens" value="PARAMETER_DEF, VARIABLE_DEF" />
<!-- <property name="ignoreFormat" value=""/> ! -->
<property name="ignoreConstructorParameter" value="true" />
<property name="ignoreSetter" value="true" />
<property name="ignoreAbstractMethods" value="false" />
</module>
<!-- Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException
is almost never acceptable. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="IllegalCatch">
<property name="illegalClassNames"
value="java.lang.Exception, java.lang.Throwable, java.lang.RuntimeException" />
</module>
<!-- Checks for illegal instantiations where a factory method is preferred.
! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- KIEKER on for ??? ! -->
<module name="IllegalInstantiation">
<property name="classes" value="java.lang.Boolean" />
</module>
<!-- This check can be used to ensure that types are not declared to be
thrown. ! -->
<!-- Declaring to throw java.lang.Error or java.lang.RuntimeException is
almost never acceptable. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#IllegalThrows
! -->
<module name="IllegalThrows">
<property name="illegalClassNames"
value="java.lang.Throwable, java.lang.Error, java.lang.RuntimeException" />
</module>
<!-- Checks for illegal tokens. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- KIEKER off <module name="IllegalToken"> <property name="tokens" value="LITERAL_SWITCH,
POST_INC, POST_DEC"/> </module> ! -->
<!-- Checks for illegal token text. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- Default: OFF <module name="IllegalTokenText"> <property name="tokens"
value=""/> <property name="format" value=""/> <property name="ignoreCase"
value="false"/> <property name="message" value=""/> </module> ! -->
<!-- Checks that particular classes are never used as types in variable
declarations, return values or parameters. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- KIEKER removed format value="^(.*[\\.])?Abstract.*$" ! -->
<module name="IllegalType">
<property name="tokens" value="PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF" />
<property name="illegalClassNames"
value="java.util.GregorianCalendar, java.util.Hashtable,
java.util.HashSet, java.util.HashMap, java.util.ArrayList,
java.util.LinkedList, java.util.LinkedHashMap,
java.util.LinkedHashSet, java.util.TreeSet,
java.util.TreeMap, java.util.Vector" />
<property name="legalAbstractClassNames" value="" />
<property name="ignoredMethodNames" value="getInitialContext, getEnvironment" />
<property name="format" value="XXX" />
</module>
<!-- Checks for assignments in subexpressions, such as in String s = Integer.toString(i
= 2);. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="InnerAssignment">
<property name="tokens"
value="ASSIGN, BAND_ASSIGN, BOR_ASSIGN, BSR_ASSIGN, BXOR_ASSIGN,
DIV_ASSIGN, MINUS_ASSIGN, MOD_ASSIGN, PLUS_ASSIGN, SL_ASSIGN,
SR_ASSIGN, STAR_ASSIGN" />
</module>
<!-- Ensures that the setUp(), tearDown()methods are named correctly, have
no arguments, ! -->
<!-- return void and are either public or protected. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- <module name="JUnitTestCase"/> -->
<!-- Checks that there are no "magic numbers", where a magic number is
a numeric literal ! -->
<!-- that is not defined as a constant. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- deactivated for Kieker <module name="MagicNumber"> <property name="tokens"
value="NUM_DOUBLE, NUM_FLOAT, NUM_INT, NUM_LONG"/> <property name="ignoreNumbers"
value="-1, 0, 1, 2"/> <property name="ignoreHashCodeMethod" value="false"/>
</module> ! -->
<!-- Checks that classes (except abtract one) define a ctor and don't rely
on the default one. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="MissingCtor" />
<!-- Checks that switch statement has "default" clause. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="MissingSwitchDefault" />
<!-- Check for ensuring that for loop control variables are not modified
inside the for block. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#ModifiedControlVariable
! -->
<module name="ModifiedControlVariable" />
<!-- Checks for multiple occurrences of the same string literal within
a single file. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#MultipleStringLiterals
! -->
<!-- KIEKER off for now <module name="MultipleStringLiterals"> <property
name="allowedDuplicates" value="1"/> <property name="ignoreStringsRegexp"
value='^""$'/> <property name="ignoreOccurrenceContext" value="ANNOTATION"/>
</module> ! -->
<!-- Checks that each variable declaration is in its own statement and
on its own line. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="MultipleVariableDeclarations" />
<!-- Restricts nested for blocks to a specified depth. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#NestedForDepth
! -->
<module name="NestedForDepth">
<property name="max" value="2" />
</module>
<!-- Restricts nested if-else blocks to a specified depth. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="NestedIfDepth">
<property name="max" value="3" />
</module>
<!-- Restricts nested try-catch blocks to a specified depth. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="NestedTryDepth">
<property name="max" value="1" />
</module>
<!-- Checks that the clone method is not overridden from the Object class.
! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#NoClone ! -->
<module name="NoClone" />
<!-- Verifies there are no finalize() methods defined in a class. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#NoFinalizer
! -->
<module name="NoFinalizer" />
<!-- Checks there is only one statement per line. ! -->
<!-- See http://checkstyle.sourceforge.net/config_coding.html#OneStatementPerLine
! -->
<module name="OneStatementPerLine" />
<!-- Ensure a class has a package declaration. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="PackageDeclaration">
<!-- <property name="ignoreDirectoryName" value="false"/> -->
</module>
<!-- Disallow assignment of parameters. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="ParameterAssignment" />
<!-- Checks for redundant exceptions declared in throws clause such as
duplicates, ! -->
<!-- unchecked exceptions or subclasses of another declared exception.
! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- <module name="RedundantThrows"> -->
<!-- <property name="allowUnchecked" value="true"/> -->
<!-- <property name="allowSubclasses" value="false"/> -->
<!-- <property name="logLoadErrors" value="true"/> -->
<!-- <property name="suppressLoadErrors" value="false"/> -->
<!-- </module> -->
<!-- Checks that code doesn't rely on the "this." default. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="RequireThis">
<property name="checkFields" value="true" />
<property name="checkMethods" value="true" />
</module>
<!-- Restrict the number of return statements. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="ReturnCount">
<property name="max" value="2" />
<property name="format" value="" />
</module>
<!-- Checks for overly complicated boolean expressions. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="SimplifyBooleanExpression" />
<!-- Checks for overly complicated boolean return statements. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="SimplifyBooleanReturn" />
<!-- Checks that string literals are not used with == or !=. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="StringLiteralEquality" />
<!-- Checks that an overriding clone() method invokes super.clone(). ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="SuperClone" />
<!-- Checks that an overriding finalize() method invokes super.finalize().
! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<module name="SuperFinalize" />
<!-- Checks for the use of unnecessary parentheses. ! -->
<!-- See http://checkstyle.sf.net/config_coding.html ! -->
<!-- <module name="UnnecessaryParentheses"/> ! -->
<!-- !________________________________________________________________________________________
! ! I M P O R T S !________________________________________________________________________________________
! -->
<!-- Checks that there are no import statements that use the * notation.
! -->
<!-- See http://checkstyle.sf.net/config_import.html ! -->
<module name="AvoidStarImport">
<property name="excludes" value="" />
<property name="allowClassImports" value="false" />
<property name="allowStaticMemberImports" value="false" />
</module>
<!-- Checks that there are no static import statements. ! -->
<!-- See http://checkstyle.sourceforge.net/config_imports.html#AvoidStaticImport
! -->
<module name="AvoidStaticImport">
<property name="excludes" value="" />
</module>
<!-- Checks for imports from a set of illegal packages. ! -->
<!-- See http://checkstyle.sf.net/config_import.html ! -->
<module name="IllegalImport">
<property name="illegalPkgs" value="junit.framework" />
<property name="illegalPkgs" value="sun" />
<property name="illegalPkgs" value="java.util.logging" />
</module>
<!-- Controls what can be imported in each package. Useful for ensuring
that application layering rules ! -->
<!-- are not violated, especially on large projects. ! -->
<!-- See http://checkstyle.sourceforge.net/config_imports.html#ImportControl
! -->
<!-- Default: OFF <module name="ImportControl"> <property name="file" value=""/>
<property name="url" value=""/> </module> ! -->
<!-- Checks the ordering/grouping of imports. ! -->
<!-- See http://checkstyle.sf.net/config_import.html ! -->
<module name="ImportOrder">
<property name="option" value="under" />
<property name="groups"
value="java,javax,junit,org,com,ch,de,kieker,kieker.test" />
<property name="ordered" value="true" />
<property name="separated" value="true" />
<property name="caseSensitive" value="true" />
</module>
<!-- Checks for redundant import statements. ! -->
<!-- See http://checkstyle.sf.net/config_import.html ! -->
<module name="RedundantImport" />
<!-- Checks for unused import statements. ! -->
<!-- See http://checkstyle.sf.net/config_import.html ! -->
<module name="UnusedImports" />
<!-- !________________________________________________________________________________________
! ! J A V A D O C S !________________________________________________________________________________________
! -->
<!-- Checks to ensure that the javadoc tags exist (if required) ! -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocMethod ! -->
<!-- KIEKER: adapted ! -->
<module name="JavadocMethod">
<property name="severity" value="info" />
<property name="scope" value="protected" />
<!-- <property name="excludeScope" value=""/> ! -->
<property name="allowUndeclaredRTE" value="false" />
<property name="allowThrowsTagsForSubclasses" value="false" />
<property name="allowMissingParamTags" value="false" />
<property name="allowMissingThrowsTags" value="false" />
<property name="allowMissingReturnTag" value="false" />
<property name="allowMissingJavadoc" value="false" />
<property name="allowMissingPropertyJavadoc" value="true" />
<property name="logLoadErrors" value="true" />
<property name="suppressLoadErrors" value="false" />
<property name="tokens" value="METHOD_DEF, CTOR_DEF" />
</module>
<!-- Validates Javadoc comments to help ensure they are well formed. ! -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocStyle ! -->
<module name="JavadocStyle">
<property name="severity" value="info" />
<property name="scope" value="private" />
<!-- <property name="excludeScope" value=""/> ! -->
<property name="checkFirstSentence" value="true" />
<!--TODO: <property name="endOfSentenceFormat" value="([.?!][ \t\n\r\f<])|([.?!]$)"/>
! -->
<property name="checkEmptyJavadoc" value="false" />
<property name="checkHtml" value="false" />
<property name="tokens"
value="INTERFACE_DEF, CLASS_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
</module>
<!-- Checks Javadoc comments for class and interface definitions. ! -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocType ! -->
<module name="JavadocType">
<property name="severity" value="info" />
<property name="scope" value="private" />
<!--<property name="excludeScope" value=""/>! -->
<property name="authorFormat" value="" />
<!--<property name="versionFormat" value=""/>! -->
<property name="allowMissingParamTags" value="false" />
<property name="allowUnknownTags" value="false" />
<property name="tokens" value="INTERFACE_DEF, CLASS_DEF" />
</module>
<module name="JavadocType">
<property name="severity" value="error" />
<property name="scope" value="package" />
<property name="authorFormat" value="\S" />
</module>
<!-- Checks that variables have Javadoc comments. ! -->
<!-- Deactivated due to #1345 ! -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocVariable ! -->
<!-- <module name="JavadocVariable"> <property name="severity" value="info"/>
<property name="scope" value="protected"/> ! -->
<!-- <property name="excludeScope" value=""/> ! -->
<!-- </module> ! -->
<!-- Outputs a JavaDoc tag as information. ! -->
<!-- See http://checkstyle.sourceforge.net/config_javadoc.html#WriteTag
! -->
<!-- KIEKER <module name="WriteTag"> <property name="severity" value="info"/>
<property name="tag" value=""/> <property name="tagFormat" value=""/> <property
name="tagSeverity" value="info"/> </module> -->
<!-- !________________________________________________________________________________________
! ! M E T R I C S !________________________________________________________________________________________
! -->
<!-- Restrict the number of number of &&, || and ^ in an expression. ! -->
<!-- See http://checkstyle.sf.net/config_metrics.html ! -->
<!-- KIEKER Off -->
<!-- <module name="BooleanExpressionComplexity"> <property name="severity"
value="info"/> <property name="max" value="3"/> <property name="tokens" value="LAND,
BAND, LOR, BOR, BXOR"/> </module> -->
<!-- This metric measures the number of instantiations of other classes
within the given class. ! -->
<!-- See http://checkstyle.sf.net/config_metrics.html ! -->
<!-- KIEKER Off -->
<!-- <module name="ClassDataAbstractionCoupling"> <property name="severity"
value="info"/> <property name="max" value="7"/> </module> -->
<!-- The number of other classes a given class relies on. ! -->
<!-- See http://checkstyle.sf.net/config_metrics.html ! -->
<!-- KIEKER Off -->
<!--<module name="ClassFanOutComplexity"> <property name="severity" value="info"/>
<property name="max" value="20"/> </module> -->
<!-- Checks cyclomatic complexity against a specified limit. ! -->
<!-- See http://checkstyle.sf.net/config_metrics.html ! -->
<module name="CyclomaticComplexity">
<property name="severity" value="ignore" />
<property name="max" value="10" />
</module>
<!-- Determines complexity of methods, classes and files by counting the
Non Commenting Source Statements (NCSS). ! -->
<!-- See http://checkstyle.sourceforge.net/config_metrics.html#JavaNCSS
! -->
<!-- KIEKER Off -->
<!--<module name="JavaNCSS"> <property name="severity" value="info"/> <property
name="methodMaximum" value="50"/> <property name="classMaximum" value="1500"/>
<property name="fileMaximum" value="2000"/> </module> -->
<!-- The NPATH metric computes the number of possible execution paths through
a function. ! -->
<!-- See http://checkstyle.sf.net/config_metrics.html ! -->
<!-- KIEKER Off -->
<!--<module name="NPathComplexity"> <property name="severity" value="info"/>
<property name="max" value="200"/> </module> -->
<!-- !________________________________________________________________________________________
! ! M I S C E L L A N E O U S !________________________________________________________________________________________
! -->
<!-- Checks the style of array type definitions. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<module name="ArrayTypeStyle">
<property name="javaStyle" value="true" />
</module>
<!-- Checks for restricted tokens beneath other tokens. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<!-- Default: OFF <module name="DescendantToken"> <property name="tokens"
value=""/> <property name="limitedTokens" value=""/> <property name="minimumDepth"
value="0"/> <property name="maximumDepth" value="java.lang.Integer.MAX_VALUE"/>
<property name="minimumNumber" value="0"/> <property name="maximumNumber"
value="java.lang.Integer.MAX_VALUE"/> <property name="sumTokenCounts" value="false"/>
<property name="minimumMessage" value="descendant.token.min"/> <property
name="maximumMessage" value="descendant.token.max"/> </module> ! -->
<!-- Check that method/constructor parameters are final. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<module name="FinalParameters">
<property name="tokens" value="METHOD_DEF, CTOR_DEF" />
</module>
<!-- A generic check for code problems - the user can search for any pattern.
! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<!-- Default: OFF <module name="GenericIllegalRegexp"> <property name="format"
value="\S\s+$"/> <property name="message" value="Line has trailing spaces."/>
<property name="ignoreCase" value="false"/> <property name="ignoreComments"
value="false"/> </module> ! -->
<!-- Checks correct indentation of Java Code. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<!-- KIEKER deactivated for now <module name="Indentation"> <property name="severity"
value="info"/> <property name="basicOffset" value="4"/> <property name="braceAdjustment"
value="0"/> <property name="caseIndent" value="0"/> </module> ! -->
<!-- Checks that the outer type name and the file name match. ! -->
<!-- See http://checkstyle.sourceforge.net/config_misc.html#OuterTypeFilename
! -->
<module name="OuterTypeFilename" />
<!-- A check for TODO: comments. Actually it is a generic regular expression
matcher on Java comments. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<!-- Kieker ! -->
<module name="TodoComment">
<property name="format" value="TODO" />
<property name="severity" value="warning" />
</module>
<module name="TodoComment">
<property name="format" value="FIXME" />
<property name="severity" value="error" />
</module>
<!-- The check to ensure that requires that comments be the only thing
on a line. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<!-- KIEKER we use them <module name="TrailingComment"> <property name="format"
value="^[\\s\\}\\);]*$"/> <property name="legalComment" value=""/> </module> -->
<!-- Checks for uncommented main() methods (debugging leftovers). ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<!-- KIEKER do not check for these <module name="UncommentedMain"> <property
name="severity" value="info"/> <property name="excludedClasses" value="Main$"/>
</module> -->
<!-- Checks that long constants are defined with an upper ell. That is
'L' and not 'l'. ! -->
<!-- See http://checkstyle.sf.net/config_misc.html ! -->
<module name="UpperEll" />
<!-- !________________________________________________________________________________________
! ! M O D I F I E R S !________________________________________________________________________________________
! -->
<!-- Checks that the order of modifiers conforms to the suggestions in
the Java Language specification, ! -->
<!-- sections 8.1.1, 8.3.1 and 8.4.3. ! -->
<!-- See http://checkstyle.sf.net/config_modifiers.html ! -->
<module name="ModifierOrder" />
<!-- Checks that there are no redundant modifiers. ! -->
<!-- See http://checkstyle.sf.net/config_modifiers.html ! -->
<!-- KIEKER off <module name="RedundantModifier"> <property name="tokens"
value="METHOD_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF"/> </module> ! -->
<!-- !________________________________________________________________________________________
! ! N A M I N G C O N V E N T I O N S !________________________________________________________________________________________
! -->
<!-- Checks for abstract class name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<!-- KIEKER removed |^.*Factory$ -->
<module name="AbstractClassName">
<property name="format" value="^Abstract.*$" />
<property name="ignoreModifier" value="false" />
<property name="ignoreName" value="false" />
</module>
<!-- Checks for class type parameter name naming conventions. ! -->
<!-- See http://checkstyle.sourceforge.net/config_naming.html#ClassTypeParameterName
! -->
<module name="ClassTypeParameterName">
<property name="format" value="^[A-Z]$" />
</module>
<!-- Checks for constant name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="ConstantName">
<property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$" />
<property name="applyToPublic" value="true" />
<property name="applyToProtected" value="true" />
<property name="applyToPackage" value="true" />
<property name="applyToPrivate" value="true" />
</module>
<!-- Checks for local final variable name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="LocalFinalVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$" />
<property name="tokens" value="VARIABLE_DEF, PARAMETER_DEF" />
</module>
<!-- Checks for local variable name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="LocalVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$" />
<!-- <property name="tokens" value="PARAMETER_DEF" /> -->
</module>
<!-- Checks for member variable name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="MemberName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$" />
<property name="applyToPublic" value="true" />
<property name="applyToProtected" value="true" />
<property name="applyToPackage" value="true" />
<property name="applyToPrivate" value="true" />
</module>
<!-- Checks for method name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="MethodName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$" />
</module>
<!-- Checks for method type parameter name naming conventions. ! -->
<!-- See http://checkstyle.sourceforge.net/config_naming.html#MethodTypeParameterName
! -->
<module name="MethodTypeParameterName">
<property name="format" value="^[A-Z]$" />
</module>
<!-- Checks for package name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$" />
</module>
<!-- Checks for parameter name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="ParameterName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$" />
</module>
<!-- Checks for static variable name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<module name="StaticVariableName">
<property name="format" value="^[a-z][a-zA-Z0-9]*$" />
<property name="applyToPublic" value="true" />
<property name="applyToProtected" value="true" />
<property name="applyToPackage" value="true" />
<property name="applyToPrivate" value="true" />
</module>
<!-- Checks for type name naming conventions. ! -->
<!-- See http://checkstyle.sf.net/config_naming.html ! -->
<!-- KIEKER: modded -->
<module name="TypeName">
<property name="format" value="^[A-Z][a-zA-Z0-9]*$" />
<property name="tokens" value="CLASS_DEF" />
<property name="applyToPublic" value="true" />
<property name="applyToProtected" value="true" />
<property name="applyToPackage" value="true" />
<property name="applyToPrivate" value="true" />
</module>
<module name="TypeName">
<property name="format" value="^I[A-Z][a-zA-Z0-9]*$" />
<property name="tokens" value="INTERFACE_DEF" />
<property name="applyToPublic" value="true" />
<property name="applyToProtected" value="true" />
<property name="applyToPackage" value="true" />
<property name="applyToPrivate" value="true" />
</module>
<!-- !________________________________________________________________________________________
! ! R E G E X P !________________________________________________________________________________________
! -->
<!-- A check that makes sure that a specified pattern exists, exists less
than a set number of times, ! -->
<!-- or does not exist in the file. ! -->
<!-- See http://checkstyle.sourceforge.net/config_misc.html#Regexp ! -->
<!-- Default: OFF <module name="Regexp"> <property name="format" value=""/>
<property name="message" value=""/> <property name="illegalPattern" value="false"/>
<property name="duplicateLimit" value="-1"/> <property name="errorLimit"
value="100"/> <property name="ignoreComments" value="false"/> </module> ! -->
<!-- This class is variation on RegexpSingleline for detecting single lines
that match a ! -->
<!-- supplied regular expression in Java files. It supports suppressing
matches in Java comments. ! -->
<!-- See http://checkstyle.sourceforge.net/config_regexp.html#RegexpSinglelineJava
! -->
<!-- Default: OFF <module name="RegexpSinglelineJava"> <property name="format"
value=""/> <property name="message" value=""/> <property name="ignoreCase"
value="false"/> <property name="minimum" value="0"/> <property name="maximum"
value="0"/> <property name="ignoreComments" value="false"/> </module> ! -->
<!-- !________________________________________________________________________________________
! ! S I Z E V I O L A T I O N S !________________________________________________________________________________________
! -->
<!-- Checks for long anonymous inner classes. ! -->
<!-- See http://checkstyle.sf.net/config_sizes.html ! -->
<!-- KIEKER Set to 50 instead of 20 -->
<module name="AnonInnerLength">
<property name="severity" value="info" />
<property name="max" value="50" />
</module>
<!-- Restricts the number of executable statements to a specified limit.
! -->
<!-- See http://checkstyle.sf.net/config_sizes.html ! -->
<!-- KIEKER off <module name="ExecutableStatementCount"> <property name="severity"
value="info"/> <property name="max" value="30"/> <property name="tokens"
value="CTOR_DEF, METHOD_DEF, INSTANCE_INIT, STATIC_INIT"/> </module> ! -->
<!-- See http://checkstyle.sf.net/config_sizes.html ! -->
<!-- Checks for long lines. ! -->
<module name="LineLength">
<property name="severity" value="info" />
<property name="ignorePattern" value="^$" />
<property name="max" value="165" />