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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
|
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<head>
<title>Filters</title>
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"/>
<script type="text/javascript" src="js/anchors.js"/>
<script type="text/javascript" src="js/google-analytics.js"/>
<link rel="icon" href="images/favicon.png" type="image/x-icon" />
<link rel="shortcut icon" href="images/favicon.ico" type="image/ico" />
</head>
<body>
<section name="Content">
<macro name="toc">
<param name="fromDepth" value="1"/>
<param name="toDepth" value="1"/>
</macro>
</section>
<section name="SeverityMatchFilter">
<subsection name="Description">
<p>Since Checkstyle 3.2</p>
<p>
Filter <code>SeverityMatchFilter</code> decides
audit events according to the <a href="config.html#Severity">severity
level</a> of the event.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>severity</td>
<td>the severity level of this filter</td>
<td><a href="property_types.html#severity">Severity</a></td>
<td><code>error</code></td>
<td>3.2</td>
</tr>
<tr>
<td>acceptOnMatch</td>
<td>
If acceptOnMatch is <code>true</code>, then
the filter accepts an audit event if and only if there is
a match between the event's severity level and property
severity. If acceptOnMatch
is <code>false</code>, then the filter
accepts an audit event if and only if there is not a match
between the event's severity level and property severity.
</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
<td>3.2</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
For example, the following configuration fragment directs the
Checker to not report audit events with severity
level <code>info</code>:
</p>
<source>
<module name="SeverityMatchFilter">
<property name="severity" value="info"/>
<property name="acceptOnMatch" value="false"/>
</module>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SeverityMatchFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#Checker">Checker</a> </p>
</subsection>
</section>
<section name="SuppressionCommentFilter">
<subsection name="Description">
<p>Since Checkstyle 3.5</p>
<p>
Filter <code>SuppressionCommentFilter</code> uses
pairs of comments to suppress audit events.
</p>
<p>
Rationale: Sometimes there are legitimate reasons for violating
a check. When this is a matter of the code in question and not
personal preference, the best place to override the policy is in
the code itself. Semi-structured comments can be associated
with the check. This is sometimes superior to a separate
suppressions file, which must be kept up-to-date as the source
file is edited.
</p>
<p>
Note that the suppression comment should be put before the violation. You can use more
than one suppression comment each on separate line.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>offCommentFormat</td>
<td>comment pattern to trigger filter to begin suppression</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>"CHECKSTYLE:OFF"</code></td>
<td>3.5</td>
</tr>
<tr>
<td>onCommentFormat</td>
<td>comment pattern to trigger filter to end suppression</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>"CHECKSTYLE:ON"</code></td>
<td>3.5</td>
</tr>
<tr>
<td>checkFormat</td>
<td>check pattern to suppress</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>".*"</code></td>
<td>3.5</td>
</tr>
<tr>
<td>messageFormat</td>
<td>message pattern to suppress</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>null</code></td>
<td>3.5</td>
</tr>
<tr>
<td>checkCPP</td>
<td>whether to check C++ style comments (<code>//</code>)</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
<td>3.5</td>
</tr>
<tr>
<td>checkC</td>
<td>whether to check C style comments (<code>/* ... */</code>)</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
<td>3.5</td>
</tr>
</table>
<p>
offCommentFormat and onCommentFormat must have equal <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html#groupCount()">paren counts</a>.
</p>
</subsection>
<subsection name="Examples">
<p>
To configure a filter to suppress audit events between a comment
containing <code>CHECKSTYLE:OFF</code> and a comment containing
<code>CHECKSTYLE:ON</code>:
</p>
<source>
<module name="TreeWalker">
...
<module name="SuppressionCommentFilter"/>
...
</module>
</source>
<p>
To configure a filter to suppress audit events between a comment
containing line <code>BEGIN GENERATED CODE</code> and a comment
containing line <code>END GENERATED CODE</code>:
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="BEGIN GENERATED CODE"/>
<property name="onCommentFormat" value="END GENERATED CODE"/>
</module>
</source>
<source>
//BEGIN GENERATED CODE
@Override
public boolean equals(Object obj) { ... } // No violation events will be reported
@Override
public int hashCode() { ... } // No violation events will be reported
//END GENERATED CODE
. . .
</source>
<p>
To configure a filter so that <code>// stop constant
check</code> and <code>// resume constant check</code> marks
legitimate constant names:
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="stop constant check"/>
<property name="onCommentFormat" value="resume constant check"/>
<property name="checkFormat" value="ConstantNameCheck"/>
</module>
</source>
<source>
//stop constant check
public static final int someConstant; // won't warn here
//resume constant check
public static final int someConstant; // will warn here as constant's name doesn't match the
// pattern "^[A-Z][A-Z0-9]*$"
</source>
<p>
To configure a filter so that <code>UNUSED OFF:
<i>var</i></code> and <code>UNUSED ON: <i>var</i></code> marks a
variable or parameter known not to be used by the code by
matching the variable name in the message:
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="UNUSED OFF\: (\w+)"/>
<property name="onCommentFormat" value="UNUSED ON\: (\w+)"/>
<property name="checkFormat" value="Unused"/>
<property name="messageFormat" value="^Unused \w+ '$1'.$"/>
</module>
</source>
<source>
private static void foo(int a, int b) // UNUSED OFF: b
{
System.out.println(a);
}
private static void foo1(int a, int b) // UNUSED ON: b
{
System.out.println(a);
}
</source>
<p>
To configure a filter so that name of suppressed check mentioned
in comment <code>CSOFF: <i>regexp</i></code>
and <code>CSON: <i>regexp</i></code> mark a matching check:
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
<property name="onCommentFormat" value="CSON\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
</source>
<source>
public static final int lowerCaseConstant; // CSOFF: ConstantNameCheck
public static final int lowerCaseConstant1; // CSON: ConstantNameCheck
</source>
<p>
To configure a filter to suppress all audit events between a comment
containing <code>CHECKSTYLE_OFF: ALMOST_ALL</code> and a comment containing
<code>CHECKSTYLE_OFF: ALMOST_ALL</code> except for the <em>EqualsHashCode</em> check:
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE_OFF: ALMOST_ALL"/>
<property name="onCommentFormat" value="CHECKSTYLE_ON: ALMOST_ALL"/>
<property name="checkFormat" value="^((?!(EqualsHashCode)).)*$"/>
</module>
</source>
<source>
public static final int array []; // CHECKSTYLE_OFF: ALMOST_ALL
private String [] strArray;
private int array1 []; // CHECKSTYLE_ON: ALMOST_ALL
</source>
<p>
To configure a filter to suppress Check's violation message <b>which matches
specified message in messageFormat</b> (so suppression will be not only by
Check's name, but by message text additionally, as the same Check could report
different by message format violations) between a comment
containing <code>stop</code> and comment containing <code>resume</code>:
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="stop"/>
<property name="onCommentFormat" value="resume"/>
<property name="checkFormat" value="IllegalTypeCheck"/>
<property name="messageFormat" value="^Declaring variables, return values or parameters of type 'GregorianCalendar' is not allowed.$"/>
</module>
</source>
<p>
Code before filter above is applied with Check's audit events:
</p>
<source>
...
GregorianCalendar calendar; // Warning here: Declaring variables, return values or parameters of type 'GregorianCalendar' is not allowed.
HashSet hashSet; // Warning here: Declaring variables, return values or parameters of type 'HashSet' is not allowed.
...
</source>
<p>
Code after filter is applied:
</p>
<source>
...
//stop
GregorianCalendar calendar; // No warning here as it is suppressed by filter.
HashSet hashSet; // Warning here: Declaring variables, return values or parameters of type 'HashSet' is not allowed.
//resume
...
</source>
<p>
It is possible to specify an ID of checks, so that it can be leveraged by the
SuppressionCommentFilter to skip validations. The following examples show how to skip
validations near code that is surrounded with <code>// CSOFF <ID> (reason)</code>
and <code>// CSON <ID></code>, where ID is the ID of checks you want to suppress.
</p>
<p>
Examples of Checkstyle checks configuration:
</p>
<source>
<module name="RegexpSinglelineJava">
<property name="id" value="ignore"/>
<property name="format" value="^.*@Ignore\s*$"/>
<property name="message" value="@Ignore should have a reason."/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="systemout"/>
<property name="format" value="^.*System\.(out|err).*$"/>
<property name="message" value="Don't use System.out/err, use SLF4J instead."/>
</module>
</source>
<p>
Example of SuppressionCommentFilter configuration (checkFormat which is set to '$1'
points that ID of the checks is in the first group of offCommentFormat and
onCommentFormat regular expressions):
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CSOFF (\w+) \(\w+\)"/>
<property name="onCommentFormat" value="CSON (\w+)"/>
<property name="checkFormat" value="$1"/>
</module>
</source>
<source>
// CSOFF ignore (test has not been implemented yet)
@Ignore // should NOT fail RegexpSinglelineJava
@Test
public void testMethod() { }
// CSON ignore
// CSOFF systemout (debug)
public static void foo() {
System.out.println("Debug info."); // should NOT fail RegexpSinglelineJava
}
// CSON systemout
</source>
<p>
Example of how to configure the check to suppress more than one checks.
</p>
<source>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="@cs-\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
</source>
<source>
// @cs-: ClassDataAbstractionCoupling
// @cs-: MagicNumber
@Service // no violations from ClassDataAbstractionCoupling here
@Transactional
public class UserService {
private int value = 10022; // no violations from MagicNumber here
}
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressionCommentFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
<section name="SuppressionFilter">
<subsection name="Description">
<p>Since Checkstyle 3.2</p>
<p>
Filter <code>SuppressionFilter</code> rejects
audit events for Check errors according to
a <a href="config.html#XML_Structure"><em>suppressions XML
document</em></a> in a file. If there is no configured
suppressions file or the optional is set to true and
suppressions file was not found the Filter accepts all audit events.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>file</td>
<td>
the location of the <em>suppressions XML document</em> file.
The order the location is checked is:
<ol>
<li>as a filesystem location</li>
<li>
if no file found, and the location starts with either
<code>http://</code> or <code>https://</code>, then it
is interpreted as a URL
</li>
<li>
if no file found, then passed to the
<code>ClassLoader.getResource()</code> method.
</li>
</ol>
</td>
<td><a href="property_types.html#string">string</a></td>
<td><code>none</code></td>
<td>3.2</td>
</tr>
<tr>
<td>optional</td>
<td>
Tells what to do when the file is not existing. If
optional is set to false the file must exist, or else
it ends with error. On the other hand if optional is
true and file is not found, the filter accept all
audit events.
</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>false</code></td>
<td>6.15</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
For example, the following configuration fragment directs the
Checker to use a <code>SuppressionFilter</code>
with suppressions
file <code>config/suppressions.xml</code>:
</p>
<source>
<module name="SuppressionFilter">
<property name="file" value="config/suppressions.xml"/>
<property name="optional" value="false"/>
</module>
</source>
<p>
A <a href="config.html#XML_Structure"><em>suppressions XML
document</em></a> contains a set
of <code>suppress</code> elements, where
each <code>suppress</code> element can have the
following attributes:
</p>
<ul>
<li>
<code>files</code> -
a <a href="property_types.html#regexp">Regular Expression</a>
matched against the file name associated with an audit
event. It is optional.
</li>
<li>
<code>checks</code> -
a <a href="property_types.html#regexp">Regular Expression</a>
matched against the name of the check associated with an audit
event. Optional as long as <code>id</code> or <code>message</code> is specified.
</li>
<li>
<code>message</code> -
a <a href="property_types.html#regexp">Regular Expression</a>
matched against the message of the check associated with an audit
event. Optional as long as <code>checks</code> or <code>id</code> is specified.
</li>
<li>
<code>id</code> -
a <a href="property_types.html#string">string</a>
matched against the ID of the check associated with an audit
event. Optional as long as <code>checks</code> or <code>message</code> is specified.
</li>
<li>
<code>lines</code> - a comma-separated list of
values, where each value is
an <a href="property_types.html#integer">integer</a> or a
range of integers denoted by integer-integer. It is optional.
</li>
<li>
<code>columns</code> - a comma-separated list of
values, where each value is
an <a href="property_types.html#integer">integer</a> or a
range of integers denoted by integer-integer. It is optional.
</li>
</ul>
<p>
Each audit event is checked against
each <code>suppress</code> element. It is
suppressed if all specified attributes match against the audit
event.
</p>
<p>
You can download template of empty suppression filter
<a href="files/suppressions_none.xml">here</a>.
</p>
<p>
The following suppressions XML document directs
a <code>SuppressionFilter</code> to
reject <code>JavadocStyleCheck</code> errors for
lines 82 and 108 to 122 of
file <code>AbstractComplexityCheck.java</code>,
and <code>MagicNumberCheck</code> errors for line
221 of file <code>JavadocStyleCheck.java</code>,
and '<code>Missing a Javadoc comment</code>' errors
for all lines and files:
</p>
<source>
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">
<suppressions>
<suppress checks="JavadocStyleCheck"
files="AbstractComplexityCheck.java"
lines="82,108-122"/>
<suppress checks="MagicNumberCheck"
files="JavadocStyleCheck.java"
lines="221"/>
</suppressions>
<suppress message="Missing a Javadoc comment"/></suppressions>
</source>
<p>
As another example to suppress Check by module id:
</p>
<source>
<module name="DescendantToken">
<property name="id" value="stringEqual"/>
<property name="tokens" value="EQUAL,NOT_EQUAL"/>
<property name="limitedTokens" value="STRING_LITERAL"/>
<property name="maximumNumber" value="0"/>
<property name="maximumDepth" value="1"/>
</module>
<module name="DescendantToken">
<property name="id" value="switchNoDefault"/>
<property name="tokens" value="LITERAL_SWITCH"/>
<property name="maximumDepth" value="2"/>
<property name="limitedTokens" value="LITERAL_DEFAULT"/>
<property name="minimumNumber" value="1"/>
</module>
</source>
<p>
Then the following can be used to suppress only the first
check and not the second by using
the <code>id</code> attribute:
</p>
<source>
<suppress id="stringEqual" files="SomeTestCode.java"/>
</source>
<p>
Suppress checks for hidden files and folders:
</p>
<source>
<suppress files="[/\\]\..+" checks=".*"/>
</source>
<p>
Suppress checks for Maven-generated code:
</p>
<source>
<suppress files="[/\\]target[/\\]" checks=".*"/>
</source>
<p>
Suppress checks for archives, classes and other binary files:
</p>
<source>
<suppress files=".+\.(?:jar|zip|war|class|tar|bin)$" checks=".*"/>
</source>
<p>
Suppress checks for image files:
</p>
<source>
<suppress files=".+\.(?:png|gif|jpg|jpeg)$" checks=".*"/>
</source>
<p>
Suppress checks for non-java files:
</p>
<source>
<suppress files=".+\.(?:txt|xml|csv|sh|thrift|html|sql|eot|ttf|woff|css|png)$" checks=".*"/>
</source>
<p>
Suppress all checks in generated sources:
</p>
<source>
<suppress checks=".*" files="com[\\/]mycompany[\\/]app[\\/]gen[\\/]"/>
</source>
<p>
Suppress FileLength check on integration tests in certain folder:
</p>
<source>
<suppress checks="FileLength" files="com[\\/]mycompany[\\/]app[\\/].*IT.java"/>
</source>
<p>
Suppress naming errors on variable named 'log' in all files:
</p>
<source>
<suppress message="Name 'log' must match pattern"/>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressionFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#Checker">Checker</a> </p>
</subsection>
</section>
<section name="SuppressionXpathFilter">
<subsection name="Description">
<p>Since Checkstyle 8.6</p>
<p>
Filter <code>SuppressionXpathFilter</code> works as
<a href="config_filters.html#SuppressionFilter">SuppressionFilter</a>.
Additionally, filter processes <code>suppress-xpath</code> elements,
which contains xpath-expressions. Xpath-expressions
are queries for suppressed nodes inside the AST tree.
</p>
<p>
Note, after resolving
<a href="https://github.com/checkstyle/checkstyle/issues/4530">issue 4530</a>
CLI will have option to generate the basic suppression xpath to elements.
</p>
<p>
Currently, filter supports the following
checks:
</p>
<ul>
<li>CyclomaticComplexityCheck</li>
<li>DeclarationOrderCheck</li>
<li>DefaultComesLastCheck</li>
<li>ExplicitInitializationCheck</li>
<li>FallThroughCheck</li>
<li>HiddenFieldCheck</li>
<li>IllegalCatchCheck</li>
<li>IllegalThrowsCheck</li>
<li>JavadocMethodCheck</li>
<li>JavadocVariableCheck</li>
<li>ImportControlCheck</li>
<li>LeftCurlyCheck</li>
<li>MethodParamPadCheck</li>
<li>MultipleVariableDeclarationCheck</li>
<li>NestedForDepthCheck</li>
<li>NestedIfDepthCheck</li>
<li>NestedTryDepthCheck</li>
<li>NPathComplexityCheck</li>
<li>OneStatementPerLineCheck</li>
<li>OuterTypeNumberCheck</li>
<li>RequireThisCheck</li>
<li>RightCurlyCheck</li>
</ul>
<p>
Note, that support for other Checks will be available after resolving
<a href="https://github.com/checkstyle/checkstyle/issues/4830">issue 4830</a>.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>file</td>
<td>
the location of the <em>suppressions XML document</em> file.
The order the location is checked is:
<ol>
<li>as a filesystem location</li>
<li>
if no file found, and the location starts with either
<code>http://</code> or <code>https://</code>, then it
is interpreted as a URL
</li>
<li>
if no file found, then passed to the
<code>ClassLoader.getResource()</code> method.
</li>
</ol>
</td>
<td><a href="property_types.html#string">string</a></td>
<td><code>none</code></td>
<td>8.6</td>
</tr>
<tr>
<td>optional</td>
<td>
Tells what to do when the file is not existing. If
optional is set to false the file must exist, or else
it ends with error. On the other hand if optional is
true and file is not found, the filter accept all
audit events.
</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>false</code></td>
<td>8.6</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
For example, the following configuration fragment directs the
Checker to use a <code>SuppressionXpathFilter</code>
with suppressions
file <code>config/suppressions.xml</code>:
</p>
<source>
<module name="SuppressionXpathFilter">
<property name="file" value="config/suppressions.xml"/>
<property name="optional" value="false"/>
</module>
</source>
<p>
A <a href="config.html#XML_Structure"><em>suppressions XML
document</em></a> contains a set
of <code>suppress</code> and <code>suppress-xpath</code> elements, where
each <code>suppress-xpath</code> element can have the
following attributes:
</p>
<ul>
<li>
<code>files</code> -
a <a href="property_types.html#regexp">Regular Expression</a>
matched against the file name associated with an audit
event. It is optional.
</li>
<li>
<code>checks</code> -
a <a href="property_types.html#regexp">Regular Expression</a>
matched against the name of the check associated with an audit
event. Optional as long as <code>id</code> or <code>message</code> is specified.
</li>
<li>
<code>message</code> -
a <a href="property_types.html#regexp">Regular Expression</a>
matched against the message of the check associated with an audit
event. Optional as long as <code>checks</code> or <code>id</code> is specified.
</li>
<li>
<code>id</code> -
a <a href="property_types.html#string">string</a>
matched against the ID of the check associated with an audit
event. Optional as long as <code>checks</code> or <code>message</code> is specified.
</li>
<li>
<code>query</code> -
a <a href="property_types.html#string">string</a>
xpath query. It is optional.
</li>
</ul>
<p>
Each audit event is checked against
each <code>suppress</code> and <code>suppress-xpath</code> element. It is
suppressed if all specified attributes match against the audit
event.
</p>
<p>
The following suppressions XML document directs
a <code>SuppressionXpathFilter</code> to
reject <code>CyclomaticComplexity</code> errors for
all methods with name <i>sayHelloWorld</i> inside <i>FileOne</i>
and <i>FileTwo</i> classes:
</p>
<source>
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions Xpath Experimental 1.2//EN"
"http://checkstyle.sourceforge.net/dtds/suppressions_1_2_xpath_experimental.dtd">
<suppressions>
<suppress-xpath checks="CyclomaticComplexity"
files="FileOne.java,FileTwo.java"
query="//METHOD_DEF[@text='sayHelloWorld']"/>
</suppressions>
</source>
<p>
Suppress checks for package definitions:
</p>
<source>
<suppress-xpath checks=".*" query="/PACKAGE_DEF"/>
</source>
<p>
Suppress checks for parent element of the first variable definition:
</p>
<source>
<suppress-xpath checks=".*" query="(//VARIABLE_DEF)[1]/.."/>
</source>
<p>
Suppress checks for elements which are either class definitions,
either method definitions.
</p>
<source>
<suppress-xpath checks=".*" query="//CLASS_DEF | //METHOD_DEF"/>
</source>
<p>
Suppress checks for certain methods:
</p>
<source>
<suppress-xpath checks=".*" query="//METHOD_DEF[@text='getSomeVar'
or @text='setSomeVar']"/>
</source>
<p>
Suppress checks for variable <i>testVariable</i> inside <i>testMethod</i> method
inside <i>TestClass</i> class.
</p>
<source>
<suppress-xpath checks=".*" query="/CLASS_DEF[@text='TestClass']
//METHOD_DEF[@text='testMethod']//VARIABLE_DEF[@text='testVariable']"/>
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressionXpathFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
<section name="SuppressWarningsFilter">
<subsection name="Description">
<p>Since Checkstyle 5.7</p>
<p>
Filter <code>SuppressWarningsFilter</code> uses annotations to
suppress audit events.
</p>
<p>
Rationale: Same as for
<code>SuppressionCommentFilter</code>. In the contrary to it
here, comments are not used comments but the builtin syntax of
<code>@SuppressWarnings</code>. This can be perceived as a
more elegant solution than using comments. Also this approach
maybe supported by various IDE.
</p>
<p>
Usage: This filter only works in conjunction with a
<a href="config_annotation.html#SuppressWarningsHolder">SuppressWarningsHolder</a>, since that check finds
the annotations in the Java files and makes them available for
the filter. Because of that, a configuration that includes
this filter must also include
<code>SuppressWarningsHolder</code> as a child module of the
<code>TreeWalker</code>. Name of check in annotation is case-insensitive
and should be written with any dotted prefix or "Check" suffix removed.
</p>
</subsection>
<subsection name="Examples">
<p>
To configure the check that makes tha annotations available to
the filter.
</p>
<source>
<module name="TreeWalker">
...
<module name="SuppressWarningsHolder" />
...
</module>
</source>
<p>To configure filter to suppress audit events for annotations add:</p>
<source>
<module name="SuppressWarningsFilter" />
</source>
<source>
@SuppressWarnings({"memberName"})
private int J; // should NOT fail MemberNameCheck
@SuppressWarnings({"MemberName"})
@SuppressWarnings({"NoWhitespaceAfter"})
private int [] ARRAY; // should NOT fail MemberNameCheck and NoWhitespaceAfterCheck
</source>
<p>
It is possible to specify an ID of checks, so that it can be leveraged by the
SuppressWarningsFilter to skip validations. The following examples show how to skip
validations near code that has <code>@SuppressWarnings("checkstyle:<ID>")</code> or
just <code>@SuppressWarnings("<ID>")</code> annotation, where ID is the ID of checks
you want to suppress.
</p>
<p>
Example of Checkstyle check configuration:
</p>
<source>
<module name="RegexpSinglelineJava">
<property name="id" value="systemout"/>
<property name="format" value="^.*System\.(out|err).*$"/>
<property name="message" value="Don't use System.out/err, use SLF4J instead."/>
</module>
</source>
<p>
To make the annotations available to the filter.
</p>
<source>
<module name="TreeWalker">
...
<module name="SuppressWarningsHolder" />
...
</module>
</source>
<p>
To configure filter to suppress audit events for annotations add:
</p>
<source>
<module name="SuppressWarningsFilter" />
</source>
<source>
@SuppressWarnings("checkstyle:systemout")
public static void foo() {
System.out.println("Debug info."); // should NOT fail RegexpSinglelineJava
}
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressWarningsFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#Checker">Checker</a> </p>
</subsection>
</section>
<section name="SuppressWithNearbyCommentFilter">
<subsection name="Description">
<p>Since Checkstyle 5.0</p>
<p>
Filter <code>SuppressWithNearbyCommentFilter</code> uses
individual comments to suppress audit events.
</p>
<p>
Rationale: Same as <code>SuppressionCommentFilter</code>.
Whereas the SuppressionCommentFilter uses matched pairs of
filters to turn on/off comment matching,
<code>SuppressWithNearbyCommentFilter</code> uses
single comments. This requires fewer lines to mark a region, and
may be aesthetically preferable in some contexts.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>commentFormat</td>
<td>comment pattern to trigger filter to begin suppression</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>"SUPPRESS CHECKSTYLE (\w+)"</code></td>
<td>5.0</td>
</tr>
<tr>
<td>checkFormat</td>
<td>check pattern to suppress</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>".*"</code></td>
<td>5.0</td>
</tr>
<tr>
<td>messageFormat</td>
<td>message pattern to suppress</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>null</code></td>
<td>5.0</td>
</tr>
<tr>
<td>influenceFormat</td>
<td>a negative/zero/positive value that defines the number of
lines preceding/at/following the suppression comment</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>"0"</code></td>
<td>5.0</td>
</tr>
<tr>
<td>checkCPP</td>
<td>whether to check C++ style comments (<code>//</code>)</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
<td>5.0</td>
</tr>
<tr>
<td>checkC</td>
<td>whether to check C style comments (<code>/* ... */</code>)</td>
<td><a href="property_types.html#boolean">Boolean</a></td>
<td><code>true</code></td>
<td>5.0</td>
</tr>
</table>
</subsection>
<subsection name="Examples">
<p>
To configure a filter to suppress audit events for <i>check</i>
on any line with a comment <code>SUPPRESS CHECKSTYLE <i>check</i></code>:
</p>
<source>
<module name="SuppressWithNearbyCommentFilter"/>
</source>
<source>
private int [] array; // SUPPRESS CHECKSTYLE
</source>
<p>
To configure a filter to suppress all audit events on any line
containing the comment <code>CHECKSTYLE IGNORE THIS LINE</code>:
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE"/>
<property name="checkFormat" value=".*"/>
<property name="influenceFormat" value="0"/>
</module>
</source>
<source>
public static final int lowerCaseConstant; // CHECKSTYLE IGNORE THIS LINE
</source>
<p>
To configure a filter so that
<code>// OK to catch (Throwable|Exception|RuntimeException) here</code>
permits the current and previous line to avoid generating an IllegalCatch
audit event:
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="OK to catch (\w+) here"/>
<property name="checkFormat" value="IllegalCatchCheck"/>
<property name="messageFormat" value="$1"/>
<property name="influenceFormat" value="-1"/>
</module>
</source>
<source>
. . .
catch (RuntimeException re) {
// OK to catch RuntimeException here
}
catch (Throwable th) { ... }
. . .
</source>
<p>
To configure a filter so that <code>CHECKSTYLE IGNORE <i>check</i> FOR NEXT <i>var</i> LINES</code>
avoids triggering any audits for the given check for the current line and the next <i>var</i> lines
(for a total of <i>var</i>+1 lines):
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="$2"/>
</module>
</source>
<source>
public static final int lowerCaseConstant; // CHECKSTYLE IGNORE ConstantNameCheck FOR NEXT 3 LINES
public static final int lowerCaseConstant1;
public static final int lowerCaseConstant2;
public static final int lowerCaseConstant3;
public static final int lowerCaseConstant4; // will warn here
</source>
<p>
To configure a filter to avoid any audits on code like:
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="ALLOW (\\w+) ON PREVIOUS LINE"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="-1"/>
</module>
</source>
<source>
private int D2;
// ALLOW MemberName ON PREVIOUS LINE
. . .
</source>
<p>
To configure a filter to allow suppress one or more Checks(separated by "|")
and demand comment no less than 14 symbols:
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="@cs\.suppress \[(\w+(\|\w+)*)\] \w[-\.'`,:;\w ]{14,}"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="1"/>
</module>
</source>
<source>
public static final int [] array; // @cs.suppress [ConstantName|NoWhitespaceAfter] A comment here
</source>
<p>
It is possible to specify an ID of checks, so that it can be leveraged by the
SuppressWithNearbyCommentFilter to skip validations. The following examples
show how to skip validations near code that has comment like
<code>// @cs-: <ID/> (reason)</code>, where ID is the ID of checks you want to
suppress.
</p>
<p>
Examples of Checkstyle checks configuration:
</p>
<source>
<module name="RegexpSinglelineJava">
<property name="id" value="ignore"/>
<property name="format" value="^.*@Ignore\s*$"/>
<property name="message" value="@Ignore should have a reason."/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="systemout"/>
<property name="format" value="^.*System\.(out|err).*$"/>
<property name="message" value="Don't use System.out/err, use SLF4J instead."/>
</module>
</source>
<p>
Example of SuppressWithNearbyCommentFilter configuration (checkFormat which
is set to '$1' points that ID of the checks is in the first group of
commentFormat regular expressions):
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="@cs-: (\w+) \(\w+\)"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="0"/>
</module>
</source>
<source>
@Ignore // @cs-: ignore (test has not been implemented yet)
@Test
public void testMethod() { }
public static void foo() {
System.out.println("Debug info."); // @cs-: systemout (should not fail RegexpSinglelineJava)
}
</source>
<p>
Example of how to configure the check to suppress more than one checks.
The influence format format is specified in the second regexp group.
</p>
<source>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="@cs-\: ([\w\|]+) influence (\d+)"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="$2"/>
</module>
</source>
<source>
// @cs-: ClassDataAbstractionCoupling influence 2
// @cs-: MagicNumber influence 4
@Service // no violations from ClassDataAbstractionCoupling here
@Transactional
public class UserService {
private int value = 10022; // no violations from MagicNumber here
}
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressWithNearbyCommentFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#TreeWalker">TreeWalker</a> </p>
</subsection>
</section>
<section name="SuppressWithPlainTextCommentFilter">
<subsection name="Description">
<p>Since Checkstyle 8.6</p>
<p>
Filter <code>SuppressWithPlainTextCommentFilter</code> uses plain text to suppress
audit events. The filter can be used only to suppress audit events received from
the checks which implement FileSetCheck interface. In other words, the checks
which have Checker as a parent module. The filter knows nothing about AST,
it treats only plain text comments and extracts the information required
for suppression from the plain text comments. Currently the filter supports
only single line comments.
</p>
<p>
Please, be aware of the fact that, it is not recommended to use the filter
for Java code anymore, however you still are able to use it to suppress audit
events received from the checks which implement FileSetCheck interface.
</p>
<p>
Rationale: Sometimes there are legitimate reasons for violating
a check. When this is a matter of the code in question and not
personal preference, the best place to override the policy is in
the code itself. Semi-structured comments can be associated
with the check. This is sometimes superior to a separate
suppressions file, which must be kept up-to-date as the source
file is edited.
</p>
<p>
Note that the suppression comment should be put before the violation. You can use more
than one suppression comment each on separate line.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>offCommentFormat</td>
<td>comment pattern to trigger filter to begin suppression</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>"// CHECKSTYLE:OFF"</code></td>
<td>8.6</td>
</tr>
<tr>
<td>onCommentFormat</td>
<td>comment pattern to trigger filter to end suppression</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>"// CHECKSTYLE:ON"</code></td>
<td>8.6</td>
</tr>
<tr>
<td>checkFormat</td>
<td>check pattern to suppress</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>".*"</code></td>
<td>8.6</td>
</tr>
<tr>
<td>messageFormat</td>
<td>message pattern to suppress</td>
<td><a href="property_types.html#regexp">Regular Expression</a></td>
<td><code>null</code></td>
<td>8.6</td>
</tr>
</table>
<p>
offCommentFormat and onCommentFormat must have equal <a
href="https://docs.oracle.com/javase/7/docs/api/java/util/regex/Matcher.html#groupCount()">paren counts</a>.
</p>
</subsection>
<subsection name="Examples">
<p>
To configure a filter to suppress audit events between a comment
containing <code>CHECKSTYLE:OFF</code> and a comment containing
<code>CHECKSTYLE:ON</code>:
</p>
<source>
<module name="Checker">
...
<module name="SuppressWithPlainTextCommentFilter"/>
...
</module>
</source>
<p>
To configure a filter to suppress audit events between a comment
containing line <code>BEGIN GENERATED CONTENT</code> and a comment
containing line <code>END GENERATED CONTENT</code>
(Checker is configured to check only properties files):
</p>
<source>
<module name="Checker">
<property name="fileExtensions" value="properties"/>
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="BEGIN GENERATED CONTENT"/>
<property name="onCommentFormat" value="END GENERATED CONTENT"/>
</module>
</module>
</source>
<source>
//BEGIN GENERATED CONTENT
my.property=value1 // No violation events will be reported
my.property=value2 // No violation events will be reported
//END GENERATED CONTENT
. . .
</source>
<p>
To configure a filter so that <code>-- stop tab
check</code> and <code>-- resume tab check</code> marks allowed tab positions
(Checker is configured to check only sql files):
</p>
<source>
<module name="Checker">
<property name="fileExtensions" value="sql"/>
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="stop tab check"/>
<property name="onCommentFormat" value="resume tab check"/>
<property name="checkFormat" value="FileTabCharacterCheck"/>
</module>
</module>
</source>
<source>
-- stop tab check
SELECT * FROM users // won't warn here if there is a tab character on line
-- resume tab check
SELECT 1 // will warn here if there is a tab character on line
</source>
<p>
To configure a filter so that name of suppressed check mentioned
in comment <code>CSOFF: <i>regexp</i></code>
and <code>CSON: <i>regexp</i></code> mark a matching check
(Checker is configured to check only xml files):
</p>
<source>
<module name="Checker">
<property name="fileExtensions" value="xml"/>
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
<property name="onCommentFormat" value="CSON\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
</module>
</source>
<source>
// CSOFF: RegexpSinglelineCheck
<condition property="checkstyle.ant.skip"> // RegexpSingleline check won't warn here if the line matches regexp
<isset property="checkstyle.ant.skip"/> // RegexpSingleline check won't warn here if the line matches regexp
</condition> // RegexpSingleline check won't warn here if the line matches regexp
// CSON: RegexpSinglelineCheck
<property name="checkstyle.pattern.todo" value="NOTHingWillMatCH_-"/> // RegexpSingleline check will warn here if the line matches regexp
</source>
<p>
To configure a filter to suppress all audit events between a comment
containing <code>CHECKSTYLE_OFF: ALMOST_ALL</code> and a comment containing
<code>CHECKSTYLE_OFF: ALMOST_ALL</code> except for the <em>EqualsHashCode</em> check
(Checker is configured to check only java files):
</p>
<source>
<module name="Checker">
<property name="fileExtensions" value="java"/>
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE_OFF: ALMOST_ALL"/>
<property name="onCommentFormat" value="CHECKSTYLE_ON: ALMOST_ALL"/>
<property name="checkFormat" value="^((?!(FileTabCharacterCheck)).)*$"/>
</module>
</module>
</source>
<source>
// CHECKSTYLE_OFF: ALMOST_ALL
public static final int array [];
private String [] strArray;
// CHECKSTYLE_ON: ALMOST_ALL
private int array1 [];
</source>
<p>
To configure a filter to suppress Check's violation message <b>which matches
specified message in messageFormat</b> (so suppression will not be only by
Check's name, but also by message text, as the same Check can report
violations with different message format) between a comment
containing <code>stop</code> and comment containing <code>resume</code>:
</p>
<source>
<module name="Checker">
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="stop"/>
<property name="onCommentFormat" value="resume"/>
<property name="checkFormat" value="FileTabCharacterCheck"/>
<property name="messageFormat" value="^File contains tab characters (this is the first instance)\.$"/>
</module>
</module>
</source>
<p>
It is possible to specify an ID of checks, so that it can be leveraged by the
SuppressWithPlainTextCommentFilter to skip validations.
The following examples show how to skip validations near code that is surrounded
with <code>-- CSOFF <ID> (reason)</code> and <code>-- CSON <ID></code>,
where ID is the ID of checks you want to suppress.
</p>
<p>
Examples of Checkstyle checks configuration:
</p>
<source>
<module name="RegexpSinglelineJava">
<property name="id" value="count"/>
<property name="format" value="^.*COUNT(*).*$"/>
<property name="message" value="Don't use COUNT(*), use COUNT(1) instead."/>
</module>
<module name="RegexpSinglelineJava">
<property name="id" value="join"/>
<property name="format" value="^.*JOIN\s.+\s(ON|USING)$"/>
<property name="message" value="Don't use JOIN, use sub-select instead."/>
</module>
</source>
<p>
Example of SuppressWithPlainTextCommentFilter configuration (checkFormat which is set to '$1'
points that ID of the checks is in the first group of offCommentFormat and
onCommentFormat regular expressions):
</p>
<source>
<module name="Checker">
<property name="fileExtensions" value="sql"/>
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="CSOFF (\w+) \(\w+\)"/>
<property name="onCommentFormat" value="CSON (\w+)"/>
<property name="checkFormat" value="$1"/>
</module>
</module>
</source>
<source>
-- CSOFF join (it is ok to use join here for performance reasons)
SELECT name, job_name
FROM users AS u
JOIN jobs AS j ON u.job_id = j.id
-- CSON join
-- CSOFF count (test query execution plan)
EXPLAIN SELECT COUNT(*) FROM restaurants
-- CSON count
</source>
<p>
Example of how to configure the check to suppress more than one check
(Checker is configured to check only sql files).
</p>
<source>
<module name="Checker">
<property name="fileExtensions" value="sql"/>
<module name="SuppressWithPlainTextCommentFilter">
<property name="offCommentFormat" value="@cs-\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
</module>
</source>
<source>
-- @cs-: RegexpSinglelineCheck
-- @cs-: FileTabCharacterCheck
CREATE TABLE STATION (
ID INTEGER PRIMARY KEY,
CITY CHAR(20),
STATE CHAR(2),
LAT_N REAL,
LONG_W REAL);
</source>
</subsection>
<subsection name="Example of Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressWithPlainTextCommentFilter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Package">
<p> com.puppycrawl.tools.checkstyle.filters </p>
</subsection>
<subsection name="Parent Module">
<p> <a href="config.html#Checker">Checker</a> </p>
</subsection>
</section>
</body>
</document>
|
