forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config_whitespace.xml
3794 lines (3520 loc) · 147 KB
/
config_whitespace.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"?>
<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 https://maven.apache.org/xsd/xdoc-2.0.xsd">
<head>
<title>Whitespace</title>
</head>
<body>
<section name="Content">
<macro name="toc">
<param name="fromDepth" value="1"/>
<param name="toDepth" value="1"/>
</macro>
</section>
<section name="EmptyForInitializerPad">
<p>Since Checkstyle 3.4</p>
<subsection name="Description" id="EmptyForInitializerPad_Description">
<p>
Checks the padding of an empty for initializer; that is whether
a white space is required at an empty for initializer, or such white
space is forbidden. No check occurs if there is a line wrap at the
initializer, as in
</p>
<source>
for (
; i < j; i++, j--)
</source>
</subsection>
<subsection name="Properties" id="EmptyForInitializerPad_Properties">
<div class="wrapper">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>option</td>
<td>Specify policy on how to pad an empty for iterator.</td>
<td><a href="property_types.html#PadOption">PadOption</a></td>
<td><code>nospace</code></td>
<td>3.4</td>
</tr>
</table>
</div>
</subsection>
<subsection name="Examples" id="EmptyForInitializerPad_Examples">
<p>
To configure the check:
</p>
<source>
<module name="EmptyForInitializerPad"/>
</source>
<p>
Example:
</p>
<source>
for ( ; i < 1; i++ ); // violation semicolon is preceded with whitespace
for (; i < 2; i++ ); // ok
for (;i<2;i++); // ok
for ( ;i<2;i++); // violation semicolon is preceded with whitespace
for (
; i < 2; i++ ); // ok
</source>
<p>
To configure the check to require white space at an empty for
iterator:
</p>
<source>
<module name="EmptyForInitializerPad">
<property name="option" value="space"/>
</module>
</source>
<p>
Example:
</p>
<source>
for ( ; i < 2; i++ ); // ok
for (; i < 2; i++ ); // violation semicolon is not preceded with whitespace
for (;i<2;i++); // violation semicolon is not preceded with whitespace
for ( ;i<2;i++); // ok
for (
; i < 2; i++ ); // ok
</source>
</subsection>
<subsection name="Example of Usage" id="EmptyForInitializerPad_Example_of_Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+EmptyForInitializerPad">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Violation Messages" id="EmptyForInitializerPad_Violation_Messages">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.notPreceded%22">
ws.notPreceded</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.preceded%22">
ws.preceded</a>
</li>
</ul>
<p>
All messages can be customized if the default message doesn't suit you.
Please <a href="config.html#Custom_messages">see the documentation</a> to learn how to.
</p>
</subsection>
<subsection name="Package" id="EmptyForInitializerPad_Package">
<p>
com.puppycrawl.tools.checkstyle.checks.whitespace
</p>
</subsection>
<subsection name="Parent Module" id="EmptyForInitializerPad_Parent_Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="EmptyForIteratorPad">
<p>Since Checkstyle 3.0</p>
<subsection name="Description" id="EmptyForIteratorPad_Description">
<p>
Checks the padding of an empty for iterator; that is whether a white
space is required at an empty for iterator, or such white space is
forbidden. No check occurs if there is a line wrap at the iterator,
as in
</p>
<source>
for (Iterator foo = very.long.line.iterator();
foo.hasNext();
)
</source>
</subsection>
<subsection name="Properties" id="EmptyForIteratorPad_Properties">
<div class="wrapper">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>option</td>
<td>Specify policy on how to pad an empty for iterator.</td>
<td><a href="property_types.html#PadOption">PadOption</a></td>
<td><code>nospace</code></td>
<td>3.0</td>
</tr>
</table>
</div>
</subsection>
<subsection name="Examples" id="EmptyForIteratorPad_Examples">
<p>
To configure the check:
</p>
<source>
<module name="EmptyForIteratorPad"/>
</source>
<p>
Example:
</p>
<source>
for (Iterator it = map.entrySet().iterator(); it.hasNext();); // ok
for (Iterator it = map.entrySet().iterator(); it.hasNext(); ); // violation since whitespace
//after semicolon
for (Iterator foo = very.long.line.iterator();
foo.hasNext();
); // ok
</source>
<p>
To configure the check to require white space at an empty for
iterator:
</p>
<source>
<module name="EmptyForIteratorPad">
<property name="option" value="space"/>
</module>
</source>
<p>
Example:
</p>
<source>
for (Iterator it = map.entrySet().iterator(); it.hasNext();); // violation as there is no
// whitespace after semicolon
for (Iterator it = map.entrySet().iterator(); it.hasNext(); ); // ok
for (Iterator foo = very.long.line.iterator();
foo.hasNext();
); // violation as there is no whitespace after semicolon
</source>
</subsection>
<subsection name="Example of Usage" id="EmptyForIteratorPad_Example_of_Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+EmptyForIteratorPad">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+EmptyForIteratorPad">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Violation Messages" id="EmptyForIteratorPad_Violation_Messages">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.followed%22">
ws.followed</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.notFollowed%22">
ws.notFollowed</a>
</li>
</ul>
<p>
All messages can be customized if the default message doesn't suit you.
Please <a href="config.html#Custom_messages">see the documentation</a> to learn how to.
</p>
</subsection>
<subsection name="Package" id="EmptyForIteratorPad_Package">
<p>
com.puppycrawl.tools.checkstyle.checks.whitespace
</p>
</subsection>
<subsection name="Parent Module" id="EmptyForIteratorPad_Parent_Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="EmptyLineSeparator">
<p>Since Checkstyle 5.8</p>
<subsection name="Description" id="EmptyLineSeparator_Description">
<p>
Checks for empty line separators before package, all import declarations,
fields, constructors, methods, nested classes,
static initializers and instance initializers.
</p>
<p>
Checks for empty line separators before not only statements but
implementation and documentation comments and blocks as well.
</p>
<p>
ATTENTION: empty line separator is required between token siblings,
not after line where token is found.
If token does not have a sibling of the same type, then empty line
is required at its end (for example for CLASS_DEF it is after '}').
Also, trailing comments are skipped.
</p>
<p>
ATTENTION: violations from multiple empty lines cannot be suppressed via XPath:
<a href="https://github.com/checkstyle/checkstyle/issues/8179">#8179</a>.
</p>
</subsection>
<subsection name="Properties" id="EmptyLineSeparator_Properties">
<div class="wrapper">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>allowNoEmptyLineBetweenFields</td>
<td>Allow no empty line between fields.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
<td>5.8</td>
</tr>
<tr>
<td>allowMultipleEmptyLines</td>
<td>Allow multiple empty lines between class members.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>true</code></td>
<td>6.3</td>
</tr>
<tr>
<td>allowMultipleEmptyLinesInsideClassMembers</td>
<td>Allow multiple empty lines inside class members.</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>true</code></td>
<td>6.18</td>
</tr>
<tr>
<td>tokens</td>
<td>tokens to check</td>
<td>subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PACKAGE_DEF">
PACKAGE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#IMPORT">
IMPORT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#STATIC_IMPORT">
STATIC_IMPORT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">
CLASS_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">
INTERFACE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">
ENUM_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
STATIC_INIT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INSTANCE_INIT">
INSTANCE_INIT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
METHOD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">
CTOR_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">
VARIABLE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF">
RECORD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#COMPACT_CTOR_DEF">
COMPACT_CTOR_DEF</a>
.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#PACKAGE_DEF">
PACKAGE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#IMPORT">
IMPORT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#STATIC_IMPORT">
STATIC_IMPORT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">
CLASS_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">
INTERFACE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">
ENUM_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
STATIC_INIT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INSTANCE_INIT">
INSTANCE_INIT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
METHOD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">
CTOR_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">
VARIABLE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF">
RECORD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#COMPACT_CTOR_DEF">
COMPACT_CTOR_DEF</a>
.
</td>
<td>5.8</td>
</tr>
</table>
</div>
</subsection>
<subsection name="Examples" id="EmptyLineSeparator_Examples">
<p>
To configure the default check:
</p>
<source>
<module name="EmptyLineSeparator"/>
</source>
<p>
Example of declarations without empty line separator:
</p>
<source>
///////////////////////////////////////////////////
//HEADER
///////////////////////////////////////////////////
package com.whitespace; // violation, 'package' should be separated from previous line.
import java.io.Serializable; // violation, 'import' should be separated from previous line.
class Foo { // violation, 'CLASS_DEF' should be separated from previous line.
public static final int FOO_CONST = 1;
public void foo() {} // violation, 'METHOD_DEF' should be separated from previous line.
}
</source>
<p>
Example of declarations with empty line separator that is expected by the Check by
default:
</p>
<source>
///////////////////////////////////////////////////
//HEADER
///////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.whitespace;
import java.io.Serializable;
class Foo {
public static final int FOO_CONST = 1;
public void foo() {}
}
</source>
<p>
To check empty line before
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#VARIABLE_DEF">
VARIABLE_DEF</a> and
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
METHOD_DEF</a>:
</p>
<source>
<module name="EmptyLineSeparator">
<property name="tokens" value="VARIABLE_DEF, METHOD_DEF"/>
</module>
</source>
<p>
To allow no empty line between fields:
</p>
<source>
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/>
</module>
</source>
<p>
Example:
</p>
<source>
class Foo {
int field1; // ok
double field2; // ok
long field3, field4 = 10L, field5; // ok
}
</source>
<p>
Example of declarations with multiple empty lines between class members
(allowed by default):
</p>
<source>
///////////////////////////////////////////////////
//HEADER
///////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.whitespace;
import java.io.Serializable;
class Foo {
public static final int FOO_CONST = 1;
public void foo() {} // OK
}
</source>
<p>
To disallow multiple empty lines between class members:
</p>
<source>
<module name="EmptyLineSeparator">
<property name="allowMultipleEmptyLines" value="false"/>
</module>
</source>
<source>
///////////////////////////////////////////////////
//HEADER
///////////////////////////////////////////////////
package com.checkstyle.whitespace; // violation, 'package' has more than 1 empty lines before.
import java.io.Serializable; // violation, 'import' has more than 1 empty lines before.
class Foo { // violation, 'CLASS_DEF' has more than 1 empty lines before.
public static final int FOO_CONST = 1;
public void foo() {} // violation, 'METHOD_DEF' has more than 1 empty lines before.
}
</source>
<p>
To disallow multiple empty lines inside constructor,
initialization block and method:
</p>
<source>
<module name="EmptyLineSeparator">
<property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
</module>
</source>
<p>
The check is valid only for statements that have body:
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CLASS_DEF">
CLASS_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INTERFACE_DEF">
INTERFACE_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_DEF">
ENUM_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
STATIC_INIT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#INSTANCE_INIT">
INSTANCE_INIT</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
METHOD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">
CTOR_DEF</a>
.
</p>
<p>
Example of declarations with multiple empty lines inside method:
</p>
<source>
///////////////////////////////////////////////////
//HEADER
///////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.whitespace;
class Foo {
public void foo() {
System.out.println(1); // violation, There is more than 1 empty line one after another
// in previous line.
}
}
</source>
<p>
To disallow multiple empty lines between class members:
</p>
<source>
<module name="EmptyLineSeparator">
<property name="allowMultipleEmptyLines" value="false"/>
</module>
</source>
<p>Example:</p>
<source>
package com.puppycrawl.tools.checkstyle.whitespace;
class Test {
private int k;
private static void foo() {} // violation, 'METHOD_DEF' has more than 1 empty lines before.
}
</source>
</subsection>
<subsection name="Example of Usage" id="EmptyLineSeparator_Example_of_Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+EmptyLineSeparator">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+EmptyLineSeparator">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Violation Messages" id="EmptyLineSeparator_Violation_Messages">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22empty.line.separator%22">
empty.line.separator</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22empty.line.separator.multiple.lines%22">
empty.line.separator.multiple.lines</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22empty.line.separator.multiple.lines.after%22">
empty.line.separator.multiple.lines.after</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22empty.line.separator.multiple.lines.inside%22">
empty.line.separator.multiple.lines.inside</a>
</li>
</ul>
<p>
All messages can be customized if the default message doesn't suit you.
Please <a href="config.html#Custom_messages">see the documentation</a> to learn how to.
</p>
</subsection>
<subsection name="Package" id="EmptyLineSeparator_Package">
<p>
com.puppycrawl.tools.checkstyle.checks.whitespace
</p>
</subsection>
<subsection name="Parent Module" id="EmptyLineSeparator_Parent_Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="FileTabCharacter">
<p>Since Checkstyle 5.0</p>
<subsection name="Description" id="FileTabCharacter_Description">
<p>
Checks that there are no tab characters (<code>'\t'</code>) in the source code.
</p>
<p>
Rationale:
</p>
<ul>
<li>
Developers should not need to configure the tab width of their
text editors in order to be able to read source code.
</li>
<li>
From the Apache jakarta coding standards: In a distributed
development environment, when the commit messages get sent
to a mailing list, they are almost impossible to read if you
use tabs.
</li>
</ul>
</subsection>
<subsection name="Properties" id="FileTabCharacter_Properties">
<div class="wrapper">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>eachLine</td>
<td>
Control whether to report on each line containing a tab, or just the first instance.
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
<td>5.0</td>
</tr>
<tr>
<td>fileExtensions</td>
<td>Specify file type extension of files to process.</td>
<td><a href="property_types.html#String.5B.5D">String[]</a></td>
<td><code>all files</code></td>
<td>5.0</td>
</tr>
</table>
</div>
</subsection>
<subsection name="Examples" id="FileTabCharacter_Examples">
<p>To configure the check to report only the first instance in each file:</p>
<source>
<module name="FileTabCharacter"/>
</source>
<p>Example - Test.java:</p>
<source>
public class Test {
int a; // violation, indented using tab
public void foo (int arg) { // OK, indented using tab, only first occurrence in file reported
a = arg; // OK, indented using spaces
} // OK, indented using spaces
}
</source>
<p>To configure the check to report each instance in each file:</p>
<source>
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>
</source>
<p>Example - Test.java:</p>
<source>
public class Test {
int a; // violation, indented using tab
public void foo (int arg) { // violation, indented using tab
a = arg; // OK, indented using spaces
} // OK, indented using spaces
}
</source>
<p>To configure the check to report instances on only certain file types:</p>
<source>
<module name="FileTabCharacter">
<property name="fileExtensions" value="java, xml"/>
</module>
</source>
<p>Example - Test.java:</p>
<source>
public class Test {
int a; // violation, indented using tab
public void foo (int arg) { // OK, indented using tab, only first occurrence in file reported
a = arg; // OK, indented using spaces
} // OK, indented using spaces
}
</source>
<p>Example - Test.xml:</p>
<source>
<![CDATA[<?xml version="1.0" encoding="UTF-8" ?>
<UserAccount>
<FirstName>John</FirstName> <!-- violation, indented using tab -->
<LastName>Doe</LastName> <!-- only first occurrence in file reported -->
</UserAccount>]]>
</source>
<p>Example - Test.html:</p>
<source>
<head>
<title>Page Title</title> <!-- no check performed, html file extension -->
</head> <!-- not specified in check config -->
<body>
<p>This is a simple html document.</p>
</body>
</source>
</subsection>
<subsection name="Example of Usage" id="FileTabCharacter_Example_of_Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+FileTabCharacter">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+FileTabCharacter">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+FileTabCharacter">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Violation Messages" id="FileTabCharacter_Violation_Messages">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22containsTab%22">
containsTab</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22file.containsTab%22">
file.containsTab</a>
</li>
</ul>
<p>
All messages can be customized if the default message doesn't suit you.
Please <a href="config.html#Custom_messages">see the documentation</a> to learn how to.
</p>
</subsection>
<subsection name="Package" id="FileTabCharacter_Package">
<p>
com.puppycrawl.tools.checkstyle.checks.whitespace
</p>
</subsection>
<subsection name="Parent Module" id="FileTabCharacter_Parent_Module">
<p>
<a href="config.html#Checker">Checker</a>
</p>
</subsection>
</section>
<section name="GenericWhitespace">
<p>Since Checkstyle 5.0</p>
<subsection name="Description" id="GenericWhitespace_Description">
<p>
Checks that the whitespace around the Generic tokens (angle brackets)
"<" and ">" are correct to the <i>typical</i> convention.
The convention is not configurable.
</p>
<p>
Left angle bracket ("<"):
</p>
<ul>
<li> should be preceded with whitespace only in generic methods definitions.</li>
<li> should not be preceded with whitespace when it is preceded method name
or constructor.</li>
<li> should not be preceded with whitespace when following type name.</li>
<li> should not be followed with whitespace in all cases.</li>
</ul>
<p>
Right angle bracket (">"):
</p>
<ul>
<li> should not be preceded with whitespace in all cases.</li>
<li> should be followed with whitespace in almost all cases, except diamond operators
and when preceding method name or constructor.</li>
</ul>
</subsection>
<subsection name="Examples" id="GenericWhitespace_Examples">
<p>
To configure the check:
</p>
<source>
<module name="GenericWhitespace"/>
</source>
<p>
Examples with correct spacing:
</p>
<div class="wrapper">
<pre>
// Generic methods definitions
public void <K, V extends Number> boolean foo(K, V) {}
// Generic type definition
class name<T1, T2, ..., Tn> {}
// Generic type reference
OrderedPair<String, Box<Integer>> p;
// Generic preceded method name
boolean same = Util.<Integer, String>compare(p1, p2);
// Diamond operator
Pair<Integer, String> p1 = new Pair<>(1, "apple");
// Method reference
List<T> list = ImmutableList.Builder<T>::new;
// Method reference
sort(list, Comparable::<String>compareTo);
// Constructor call
MyClass obj = new <String>MyClass();
</pre>
</div>
<p>
Examples with incorrect spacing:
</p>
<div class="wrapper">
<pre>
List< String> l; // violation, "<" followed by whitespace
Box b = Box. <String>of("foo"); // violation, "<" preceded with whitespace
public<T> void foo() {} // violation, "<" not preceded with whitespace
List a = new ArrayList<> (); // violation, ">" followed by whitespace
Map<Integer, String>m; // violation, ">" not followed by whitespace
Pair<Integer, Integer > p; // violation, ">" preceded with whitespace
</pre>
</div>
</subsection>
<subsection name="Example of Usage" id="GenericWhitespace_Example_of_Usage">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+GenericWhitespace">
Google Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+GenericWhitespace">
Sun Style</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+GenericWhitespace">
Checkstyle Style</a>
</li>
</ul>
</subsection>
<subsection name="Violation Messages" id="GenericWhitespace_Violation_Messages">
<ul>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.followed%22">
ws.followed</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.illegalFollow%22">
ws.illegalFollow</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.notPreceded%22">
ws.notPreceded</a>
</li>
<li>
<a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fwhitespace+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22ws.preceded%22">
ws.preceded</a>
</li>
</ul>
<p>
All messages can be customized if the default message doesn't suit you.
Please <a href="config.html#Custom_messages">see the documentation</a> to learn how to.
</p>
</subsection>
<subsection name="Package" id="GenericWhitespace_Package">
<p>
com.puppycrawl.tools.checkstyle.checks.whitespace
</p>
</subsection>
<subsection name="Parent Module" id="GenericWhitespace_Parent_Module">
<p>
<a href="config.html#TreeWalker">TreeWalker</a>
</p>
</subsection>
</section>
<section name="MethodParamPad">
<p>Since Checkstyle 3.4</p>
<subsection name="Description" id="MethodParamPad_Description">
<p>
Checks the padding between the identifier of a method definition,
constructor definition, method call, or constructor invocation; and
the left parenthesis of the parameter list. That is, if the
identifier and left parenthesis are on the same line, checks whether
a space is required immediately after the identifier or such a space
is forbidden. If they are not on the same line, reports a violation,
unless configured to allow line breaks. To allow linebreaks after
the identifier, set property <code>allowLineBreaks</code> to <code>
true</code>.
</p>
</subsection>
<subsection name="Properties" id="MethodParamPad_Properties">
<div class="wrapper">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
<th>since</th>
</tr>
<tr>
<td>allowLineBreaks</td>
<td>
Allow a line break between the identifier and left parenthesis.
</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><code>false</code></td>
<td>3.4</td>
</tr>
<tr>
<td>option</td>
<td>Specify policy on how to pad method parameter.</td>
<td>
<a href="property_types.html#PadOption">PadOption</a>
</td>
<td><code>nospace</code></td>
<td>3.4</td>
</tr>
<tr>
<td>tokens</td>
<td>tokens to check</td>
<td>
subset of tokens
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">
CTOR_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_NEW">
LITERAL_NEW</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_CALL">
METHOD_CALL</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
METHOD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#SUPER_CTOR_CALL">
SUPER_CTOR_CALL</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">
ENUM_CONSTANT_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF">
RECORD_DEF</a>
.
</td>
<td>
<a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#CTOR_DEF">
CTOR_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#LITERAL_NEW">
LITERAL_NEW</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_CALL">
METHOD_CALL</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#METHOD_DEF">
METHOD_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#SUPER_CTOR_CALL">
SUPER_CTOR_CALL</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#ENUM_CONSTANT_DEF">
ENUM_CONSTANT_DEF</a>
, <a href="apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#RECORD_DEF">
RECORD_DEF</a>
.
</td>
<td>3.4</td>
</tr>
</table>
</div>
</subsection>
<subsection name="Examples" id="MethodParamPad_Examples">