forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ImportOrderCheck.java
987 lines (927 loc) · 37.9 KB
/
ImportOrderCheck.java
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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2020 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.imports;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.FileStatefulCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
/**
* <p>
* Checks the ordering/grouping of imports. Features are:
* </p>
* <ul>
* <li>
* groups type/static imports: ensures that groups of imports come in a specific order
* (e.g., java. comes first, javax. comes second, then everything else)
* </li>
* <li>
* adds a separation between type import groups : ensures that a blank line sit between each group
* </li>
* <li>
* type/static import groups aren't separated internally: ensures that each group aren't separated
* internally by blank line or comment
* </li>
* <li>
* sorts type/static imports inside each group: ensures that imports within each group are in
* lexicographic order
* </li>
* <li>
* sorts according to case: ensures that the comparison between imports is case sensitive, in
* <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>
* </li>
* <li>
* arrange static imports: ensures the relative order between type imports and static imports
* (see <a href="https://checkstyle.org/property_types.html#importOrder">import orders</a>)
* </li>
* </ul>
* <ul>
* <li>
* Property {@code option} - specify policy on the relative order between type imports and static
* imports.
* Default value is {@code under}.
* </li>
* <li>
* Property {@code groups} - specify list of <b>type import</b> groups (every group identified
* either by a common prefix string, or by a regular expression enclosed in forward slashes
* (e.g. {@code /regexp/}). All type imports, which does not match any group, falls into an
* additional group, located at the end.
* Thus, the empty list of type groups (the default value) means one group for all type imports.
* Default value is {@code {}}.
* </li>
* <li>
* Property {@code ordered} - control whether type imports within each group should be
* sorted.
* It doesn't affect sorting for static imports.
* Default value is true.
* </li>
* <li>
* Property {@code separated} - control whether type import groups should be separated
* by, at least, one blank line or comment and aren't separated internally.
* It doesn't affect separations for static imports.
* Default value is false.
* </li>
* <li>
* Property {@code separatedStaticGroups} - control whether static import groups should
* be separated by, at least, one blank line or comment and aren't separated internally.
* This property has effect only when the property {@code option} is is set to {@code top}
* or {@code bottom}.
* Default value is false.
* </li>
* <li>
* Property {@code caseSensitive} - control whether string comparison should be case
* sensitive or not. Case sensitive sorting is in
* <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>.
* It affects both type imports and static imports.
* Default value is true.
* </li>
* <li>
* Property {@code staticGroups} - specify list of <b>static</b> import groups (every group
* identified either by a common prefix string, or by a regular expression enclosed in forward
* slashes (e.g. {@code /regexp/}). All static imports, which does not match any group, falls into
* an additional group, located at the end. Thus, the empty list of static groups (the default
* value) means one group for all static imports. This property has effect only when the property
* {@code option} is set to {@code top} or {@code bottom}.
* Default value is {@code {}}.
* </li>
* <li>
* Property {@code sortStaticImportsAlphabetically} - control whether
* <b>static imports</b> located at <b>top</b> or <b>bottom</b> are sorted within the group.
* Default value is false.
* </li>
* <li>
* Property {@code useContainerOrderingForStatic} - control whether to use container
* ordering (Eclipse IDE term) for static imports or not.
* Default value is false.
* </li>
* <li>
* Property {@code tokens} - tokens to check
* Default value is:
* <a href="https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#STATIC_IMPORT">
* STATIC_IMPORT</a>.
* </li>
* </ul>
* <p>
* To configure the check so that it matches default Eclipse formatter configuration
* (tested on Kepler and Luna releases):
* </p>
* <ul>
* <li>
* group of static imports is on the top
* </li>
* <li>
* groups of type imports: "java" and "javax" packages first, then "org" and then all other imports
* </li>
* <li>
* imports will be sorted in the groups
* </li>
* <li>
* groups are separated by, at least, one blank line and aren't separated internally
* </li>
* </ul>
* <p>
* Notes:
* </p>
* <ul>
* <li>
* "com" package is not mentioned on configuration, because it is ignored by Eclipse Kepler and Luna
* (looks like Eclipse defect)
* </li>
* <li>
* configuration below doesn't work in all 100% cases due to inconsistent behavior prior to
* Mars release, but covers most scenarios
* </li>
* </ul>
* <pre>
* <module name="ImportOrder">
* <property name="groups" value="/^java\./,javax,org"/>
* <property name="ordered" value="true"/>
* <property name="separated" value="true"/>
* <property name="option" value="above"/>
* <property name="sortStaticImportsAlphabetically" value="true"/>
* </module>
* </pre>
* <p>
* To configure the check so that it matches default Eclipse formatter configuration
* (tested on Mars release):
* </p>
* <ul>
* <li>
* group of static imports is on the top
* </li>
* <li>
* groups of type imports: "java" and "javax" packages first, then "org" and "com",
* then all other imports as one group
* </li>
* <li>
* imports will be sorted in the groups
* </li>
* <li>
* groups are separated by, at least, one blank line and aren't separated internally
* </li>
* </ul>
* <pre>
* <module name="ImportOrder">
* <property name="groups" value="/^java\./,javax,org,com"/>
* <property name="ordered" value="true"/>
* <property name="separated" value="true"/>
* <property name="option" value="above"/>
* <property name="sortStaticImportsAlphabetically" value="true"/>
* </module>
* </pre>
* <p>
* To configure the check so that it matches default IntelliJ IDEA formatter configuration
* (tested on v2018.2):
* </p>
* <ul>
* <li>
* group of static imports is on the bottom
* </li>
* <li>
* groups of type imports: all imports except of "javax" and "java", then "javax" and "java"
* </li>
* <li>
* imports will be sorted in the groups
* </li>
* <li>
* groups are separated by, at least, one blank line and aren't separated internally
* </li>
* </ul>
* <p>
* Note: a <a href="https://checkstyle.org/config_filters.html#SuppressionXpathSingleFilter">
* suppression xpath single filter</a> is needed because
* IDEA has no blank line between "javax" and "java".
* ImportOrder has a limitation by design to enforce an empty line between groups ("java", "javax").
* There is no flexibility to enforce empty lines between some groups and no empty lines between
* other groups.
* </p>
* <p>
* Note: "separated" option is disabled because IDEA default has blank line between "java" and
* static imports, and no blank line between "javax" and "java".
* </p>
* <pre>
* <module name="ImportOrder">
* <property name="groups" value="*,javax,java"/>
* <property name="ordered" value="true"/>
* <property name="separated" value="false"/>
* <property name="option" value="bottom"/>
* <property name="sortStaticImportsAlphabetically" value="true"/>
* </module>
* <module name="SuppressionXpathSingleFilter">
* <property name="checks" value="ImportOrder"/>
* <property name="message" value="^'java\..*'.*"/>
* </module>
* </pre>
* <p>
* To configure the check so that it matches default NetBeans formatter configuration
* (tested on v8):
* </p>
* <ul>
* <li>
* groups of type imports are not defined, all imports will be sorted as a one group
* </li>
* <li>
* static imports are not separated, they will be sorted along with other imports
* </li>
* </ul>
* <pre>
* <module name="ImportOrder">
* <property name="option" value="inflow"/>
* </module>
* </pre>
* <p>
* Group descriptions enclosed in slashes are interpreted as regular expressions.
* If multiple groups match, the one matching a longer substring of the imported name
* will take precedence, with ties broken first in favor of earlier matches and finally
* in favor of the first matching group.
* </p>
* <p>
* There is always a wildcard group to which everything not in a named group belongs.
* If an import does not match a named group, the group belongs to this wildcard group.
* The wildcard group position can be specified using the {@code *} character.
* </p>
* <p>
* Check also has on option making it more flexible: <b>sortStaticImportsAlphabetically</b>
* - sets whether static imports grouped by <b>top</b> or <b>bottom</b> option should be sorted
* alphabetically or not, default value is <b>false</b>. It is applied to static imports grouped
* with <b>top</b> or <b>bottom</b> options. This option is helping in reconciling of this
* Check and other tools like Eclipse's Organize Imports feature.
* </p>
* <p>
* To configure the Check allows static imports grouped to the <b>top</b> being sorted
* alphabetically:
* </p>
* <pre>
* <module name="ImportOrder">
* <property name="sortStaticImportsAlphabetically" value="true"/>
* <property name="option" value="top"/>
* </module>
* </pre>
* <pre>
* import static java.lang.Math.PI;
* import static java.lang.Math.abs; // OK, alphabetical case sensitive ASCII order, 'P' < 'a'
* import static org.abego.treelayout.Configuration.AlignmentInLevel; // OK, alphabetical order
*
* import org.abego.*;
*
* import java.util.Set; // Wrong order for 'java.util.Set' import.
*
* public class SomeClass { ... }
* </pre>
* <p>
* To configure the Check with groups of static imports:
* </p>
* <pre>
* <module name="ImportOrder">
* <property name="staticGroups" value="org,java"/>
* <property name="sortStaticImportsAlphabetically" value="true"/>
* </module>
* </pre>
* <pre>
* import static org.abego.treelayout.Configuration.AlignmentInLevel; // Group 1
* import static java.lang.Math.abs; // Group 2
* import static java.lang.String.format; // Group 2
* import static com.google.common.primitives.Doubles.BYTES; // Group "everything else"
*
* public class SomeClass { ... }
* </pre>
* <p>
* The following example shows the idea of 'useContainerOrderingForStatic' option that is
* useful for Eclipse IDE users to match ordering validation.
* This is how the import comparison works for static imports: we first compare
* the container of the static import, container is the type enclosing the static element
* being imported. When the result of the comparison is 0 (containers are equal),
* we compare the fully qualified import names.
* For e.g. this is what is considered to be container names for the given example:
*
* import static HttpConstants.COLON => HttpConstants
* import static HttpHeaders.addHeader => HttpHeaders
* import static HttpHeaders.setHeader => HttpHeaders
* import static HttpHeaders.Names.DATE => HttpHeaders.Names
*
* According to this logic, HttpHeaders.Names should come after HttpHeaders.
* </p>
* <p>
* Example for {@code useContainerOrderingForStatic=true}
* </p>
* <pre>
* <module name="ImportOrder">
* <property name="useContainerOrderingForStatic" value="true"/>
* <property name="ordered" value="true"/>
* <property name="option" value="top"/>
* <property name="caseSensitive" value="false"/>
* <property name="sortStaticImportsAlphabetically" value="true"/>
* </module>
* </pre>
* <pre>
* import static io.netty.handler.codec.http.HttpConstants.COLON;
* import static io.netty.handler.codec.http.HttpHeaders.addHeader;
* import static io.netty.handler.codec.http.HttpHeaders.setHeader;
* import static io.netty.handler.codec.http.HttpHeaders.Names.DATE;
*
* public class InputEclipseStaticImportsOrder { }
* </pre>
* <p>
* Example for {@code useContainerOrderingForStatic=false}
* </p>
* <pre>
* <module name="ImportOrder">
* <property name="useContainerOrderingForStatic" value="false"/>
* <property name="ordered" value="true"/>
* <property name="option" value="top"/>
* <property name="caseSensitive" value="false"/>
* <property name="sortStaticImportsAlphabetically" value="true"/>
* </module>
* </pre>
* <pre>
* import static io.netty.handler.codec.http.HttpConstants.COLON;
* import static io.netty.handler.codec.http.HttpHeaders.addHeader;
* import static io.netty.handler.codec.http.HttpHeaders.setHeader;
* import static io.netty.handler.codec.http.HttpHeaders.Names.DATE; // violation
*
* public class InputEclipseStaticImportsOrder { }
* </pre>
*
* @since 3.2
*/
@FileStatefulCheck
public class ImportOrderCheck
extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_SEPARATION = "import.separation";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_ORDERING = "import.ordering";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_SEPARATED_IN_GROUP = "import.groups.separated.internally";
/** The special wildcard that catches all remaining groups. */
private static final String WILDCARD_GROUP_NAME = "*";
/** Empty array of pattern type needed to initialize check. */
private static final Pattern[] EMPTY_PATTERN_ARRAY = new Pattern[0];
/**
* Specify list of <b>type import</b> groups (every group identified either by a common prefix
* string, or by a regular expression enclosed in forward slashes (e.g. {@code /regexp/}).
* All type imports, which does not match any group, falls into an additional group,
* located at the end. Thus, the empty list of type groups (the default value) means one group
* for all type imports.
*/
private Pattern[] groups = EMPTY_PATTERN_ARRAY;
/**
* Specify list of <b>static</b> import groups (every group identified either by a common prefix
* string, or by a regular expression enclosed in forward slashes (e.g. {@code /regexp/}).
* All static imports, which does not match any group, falls into an additional group, located
* at the end. Thus, the empty list of static groups (the default value) means one group for all
* static imports. This property has effect only when the property {@code option} is set to
* {@code top} or {@code bottom}.
*/
private Pattern[] staticGroups = EMPTY_PATTERN_ARRAY;
/**
* Control whether type import groups should be separated by, at least, one blank
* line or comment and aren't separated internally. It doesn't affect separations for static
* imports.
*/
private boolean separated;
/**
* Control whether static import groups should be separated by, at least, one blank
* line or comment and aren't separated internally. This property has effect only when the
* property {@code option} is is set to {@code top} or {@code bottom}.
*/
private boolean separatedStaticGroups;
/**
* Control whether type imports within each group should be sorted.
* It doesn't affect sorting for static imports.
*/
private boolean ordered = true;
/**
* Control whether string comparison should be case sensitive or not. Case sensitive
* sorting is in <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>.
* It affects both type imports and static imports.
*/
private boolean caseSensitive = true;
/** Last imported group. */
private int lastGroup;
/** Line number of last import. */
private int lastImportLine;
/** Name of last import. */
private String lastImport;
/** If last import was static. */
private boolean lastImportStatic;
/** Whether there was any imports. */
private boolean beforeFirstImport;
/**
* Whether static and type import groups should be split apart.
* When the {@code option} property is set to {@code INFLOW}, {@code BELOW} or {@code UNDER},
* both the type and static imports use the properties {@code groups} and {@code separated}.
* When the {@code option} property is set to {@code TOP} or {@code BOTTOM}, static imports
* uses the properties {@code staticGroups} and {@code separatedStaticGroups}.
**/
private boolean staticImportsApart;
/**
* Control whether <b>static imports</b> located at <b>top</b> or <b>bottom</b> are
* sorted within the group.
*/
private boolean sortStaticImportsAlphabetically;
/**
* Control whether to use container ordering (Eclipse IDE term) for static imports
* or not.
*/
private boolean useContainerOrderingForStatic;
/**
* Specify policy on the relative order between type imports and static imports.
*/
private ImportOrderOption option = ImportOrderOption.UNDER;
/**
* Setter to specify policy on the relative order between type imports and static imports.
*
* @param optionStr string to decode option from
* @throws IllegalArgumentException if unable to decode
*/
public void setOption(String optionStr) {
option = ImportOrderOption.valueOf(optionStr.trim().toUpperCase(Locale.ENGLISH));
}
/**
* Setter to specify list of <b>type import</b> groups (every group identified either by a
* common prefix string, or by a regular expression enclosed in forward slashes
* (e.g. {@code /regexp/}). All type imports, which does not match any group, falls into an
* additional group, located at the end. Thus, the empty list of type groups (the default value)
* means one group for all type imports.
*
* @param packageGroups a comma-separated list of package names/prefixes.
*/
public void setGroups(String... packageGroups) {
groups = compilePatterns(packageGroups);
}
/**
* Setter to specify list of <b>static</b> import groups (every group identified either by a
* common prefix string, or by a regular expression enclosed in forward slashes
* (e.g. {@code /regexp/}). All static imports, which does not match any group, falls into an
* additional group, located at the end. Thus, the empty list of static groups (the default
* value) means one group for all static imports. This property has effect only when
* the property {@code option} is set to {@code top} or {@code bottom}.
*
* @param packageGroups a comma-separated list of package names/prefixes.
*/
public void setStaticGroups(String... packageGroups) {
staticGroups = compilePatterns(packageGroups);
}
/**
* Setter to control whether type imports within each group should be sorted.
* It doesn't affect sorting for static imports.
*
* @param ordered
* whether lexicographic ordering of imports within a group
* required or not.
*/
public void setOrdered(boolean ordered) {
this.ordered = ordered;
}
/**
* Setter to control whether type import groups should be separated by, at least,
* one blank line or comment and aren't separated internally.
* It doesn't affect separations for static imports.
*
* @param separated
* whether groups should be separated by one blank line or comment.
*/
public void setSeparated(boolean separated) {
this.separated = separated;
}
/**
* Setter to control whether static import groups should be separated by, at least,
* one blank line or comment and aren't separated internally.
* This property has effect only when the property
* {@code option} is is set to {@code top} or {@code bottom}.
*
* @param separatedStaticGroups
* whether groups should be separated by one blank line or comment.
*/
public void setSeparatedStaticGroups(boolean separatedStaticGroups) {
this.separatedStaticGroups = separatedStaticGroups;
}
/**
* Setter to control whether string comparison should be case sensitive or not.
* Case sensitive sorting is in
* <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>.
* It affects both type imports and static imports.
*
* @param caseSensitive
* whether string comparison should be case sensitive.
*/
public void setCaseSensitive(boolean caseSensitive) {
this.caseSensitive = caseSensitive;
}
/**
* Setter to control whether <b>static imports</b> located at <b>top</b> or
* <b>bottom</b> are sorted within the group.
*
* @param sortAlphabetically true or false.
*/
public void setSortStaticImportsAlphabetically(boolean sortAlphabetically) {
sortStaticImportsAlphabetically = sortAlphabetically;
}
/**
* Setter to control whether to use container ordering (Eclipse IDE term) for static
* imports or not.
*
* @param useContainerOrdering whether to use container ordering for static imports or not.
*/
public void setUseContainerOrderingForStatic(boolean useContainerOrdering) {
useContainerOrderingForStatic = useContainerOrdering;
}
@Override
public int[] getDefaultTokens() {
return getAcceptableTokens();
}
@Override
public int[] getAcceptableTokens() {
return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
}
@Override
public int[] getRequiredTokens() {
return new int[] {TokenTypes.IMPORT};
}
@Override
public void beginTree(DetailAST rootAST) {
lastGroup = Integer.MIN_VALUE;
lastImportLine = Integer.MIN_VALUE;
lastImport = "";
lastImportStatic = false;
beforeFirstImport = true;
staticImportsApart =
option == ImportOrderOption.TOP || option == ImportOrderOption.BOTTOM;
}
// -@cs[CyclomaticComplexity] SWITCH was transformed into IF-ELSE.
@Override
public void visitToken(DetailAST ast) {
final FullIdent ident;
final boolean isStatic;
if (ast.getType() == TokenTypes.IMPORT) {
ident = FullIdent.createFullIdentBelow(ast);
isStatic = false;
}
else {
ident = FullIdent.createFullIdent(ast.getFirstChild()
.getNextSibling());
isStatic = true;
}
// using set of IF instead of SWITCH to analyze Enum options to satisfy coverage.
// https://github.com/checkstyle/checkstyle/issues/1387
if (option == ImportOrderOption.TOP || option == ImportOrderOption.ABOVE) {
final boolean isStaticAndNotLastImport = isStatic && !lastImportStatic;
doVisitToken(ident, isStatic, isStaticAndNotLastImport, ast);
}
else if (option == ImportOrderOption.BOTTOM || option == ImportOrderOption.UNDER) {
final boolean isLastImportAndNonStatic = lastImportStatic && !isStatic;
doVisitToken(ident, isStatic, isLastImportAndNonStatic, ast);
}
else if (option == ImportOrderOption.INFLOW) {
// "previous" argument is useless here
doVisitToken(ident, isStatic, true, ast);
}
else {
throw new IllegalStateException(
"Unexpected option for static imports: " + option);
}
lastImportLine = ast.findFirstToken(TokenTypes.SEMI).getLineNo();
lastImportStatic = isStatic;
beforeFirstImport = false;
}
/**
* Shares processing...
*
* @param ident the import to process.
* @param isStatic whether the token is static or not.
* @param previous previous non-static but current is static (above), or
* previous static but current is non-static (under).
* @param ast node of the AST.
*/
private void doVisitToken(FullIdent ident, boolean isStatic, boolean previous, DetailAST ast) {
final String name = ident.getText();
final int groupIdx = getGroupNumber(isStatic && staticImportsApart, name);
if (groupIdx > lastGroup) {
if (!beforeFirstImport
&& ast.getLineNo() - lastImportLine < 2
&& needSeparator(isStatic)) {
log(ast, MSG_SEPARATION, name);
}
}
else if (groupIdx == lastGroup) {
doVisitTokenInSameGroup(isStatic, previous, name, ast);
}
else {
log(ast, MSG_ORDERING, name);
}
if (isSeparatorInGroup(groupIdx, isStatic, ast.getLineNo())) {
log(ast, MSG_SEPARATED_IN_GROUP, name);
}
lastGroup = groupIdx;
lastImport = name;
}
/**
* Checks whether import groups should be separated.
*
* @param isStatic whether the token is static or not.
* @return true if imports groups should be separated.
*/
private boolean needSeparator(boolean isStatic) {
final boolean typeImportSeparator = !isStatic && separated;
final boolean staticImportSeparator;
if (staticImportsApart) {
staticImportSeparator = isStatic && separatedStaticGroups;
}
else {
staticImportSeparator = isStatic && separated;
}
final boolean separatorBetween = isStatic != lastImportStatic
&& (separated || separatedStaticGroups);
return typeImportSeparator || staticImportSeparator || separatorBetween;
}
/**
* Checks whether imports group separated internally.
*
* @param groupIdx group number.
* @param isStatic whether the token is static or not.
* @param line the line of the current import.
* @return true if imports group are separated internally.
*/
private boolean isSeparatorInGroup(int groupIdx, boolean isStatic, int line) {
final boolean inSameGroup = groupIdx == lastGroup;
return (inSameGroup || !needSeparator(isStatic)) && isSeparatorBeforeImport(line);
}
/**
* Checks whether there is any separator before current import.
*
* @param line the line of the current import.
* @return true if there is separator before current import which isn't the first import.
*/
private boolean isSeparatorBeforeImport(int line) {
return !beforeFirstImport && line - lastImportLine > 1;
}
/**
* Shares processing...
*
* @param isStatic whether the token is static or not.
* @param previous previous non-static but current is static (above), or
* previous static but current is non-static (under).
* @param name the name of the current import.
* @param ast node of the AST.
*/
private void doVisitTokenInSameGroup(boolean isStatic,
boolean previous, String name, DetailAST ast) {
if (ordered) {
if (option == ImportOrderOption.INFLOW) {
if (isWrongOrder(name, isStatic)) {
log(ast, MSG_ORDERING, name);
}
}
else {
final boolean shouldFireError =
// previous non-static but current is static (above)
// or
// previous static but current is non-static (under)
previous
||
// current and previous static or current and
// previous non-static
lastImportStatic == isStatic
&& isWrongOrder(name, isStatic);
if (shouldFireError) {
log(ast, MSG_ORDERING, name);
}
}
}
}
/**
* Checks whether import name is in wrong order.
*
* @param name import name.
* @param isStatic whether it is a static import name.
* @return true if import name is in wrong order.
*/
private boolean isWrongOrder(String name, boolean isStatic) {
final boolean result;
if (isStatic) {
if (useContainerOrderingForStatic) {
result = compareContainerOrder(lastImport, name, caseSensitive) > 0;
}
else if (staticImportsApart) {
result = sortStaticImportsAlphabetically
&& compare(lastImport, name, caseSensitive) > 0;
}
else {
result = compare(lastImport, name, caseSensitive) > 0;
}
}
else {
// out of lexicographic order
result = compare(lastImport, name, caseSensitive) > 0;
}
return result;
}
/**
* Compares two import strings.
* We first compare the container of the static import, container being the type enclosing
* the static element being imported. When this returns 0, we compare the qualified
* import name. For e.g. this is what is considered to be container names:
* <p>
* import static HttpConstants.COLON => HttpConstants
* import static HttpHeaders.addHeader => HttpHeaders
* import static HttpHeaders.setHeader => HttpHeaders
* import static HttpHeaders.Names.DATE => HttpHeaders.Names
* </p>
* <p>
* According to this logic, HttpHeaders.Names would come after HttpHeaders.
*
* For more details, see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=473629#c3">
* static imports comparison method</a> in Eclipse.
* </p>
*
* @param importName1 first import name.
* @param importName2 second import name.
* @param caseSensitive whether the comparison of fully qualified import names is case
* sensitive.
* @return the value {@code 0} if str1 is equal to str2; a value
* less than {@code 0} if str is less than the str2 (container order
* or lexicographical); and a value greater than {@code 0} if str1 is greater than str2
* (container order or lexicographically).
*/
private static int compareContainerOrder(String importName1, String importName2,
boolean caseSensitive) {
final String container1 = getImportContainer(importName1);
final String container2 = getImportContainer(importName2);
final int compareContainersOrderResult;
if (caseSensitive) {
compareContainersOrderResult = container1.compareTo(container2);
}
else {
compareContainersOrderResult = container1.compareToIgnoreCase(container2);
}
final int result;
if (compareContainersOrderResult == 0) {
result = compare(importName1, importName2, caseSensitive);
}
else {
result = compareContainersOrderResult;
}
return result;
}
/**
* Extracts import container name from fully qualified import name.
* An import container name is the type which encloses the static element being imported.
* For example, HttpConstants, HttpHeaders, HttpHeaders.Names are import container names:
* <p>
* import static HttpConstants.COLON => HttpConstants
* import static HttpHeaders.addHeader => HttpHeaders
* import static HttpHeaders.setHeader => HttpHeaders
* import static HttpHeaders.Names.DATE => HttpHeaders.Names
* </p>
*
* @param qualifiedImportName fully qualified import name.
* @return import container name.
*/
private static String getImportContainer(String qualifiedImportName) {
final int lastDotIndex = qualifiedImportName.lastIndexOf('.');
return qualifiedImportName.substring(0, lastDotIndex);
}
/**
* Finds out what group the specified import belongs to.
*
* @param isStatic whether the token is static or not.
* @param name the import name to find.
* @return group number for given import name.
*/
private int getGroupNumber(boolean isStatic, String name) {
final Pattern[] patterns;
if (isStatic) {
patterns = staticGroups;
}
else {
patterns = groups;
}
int number = getGroupNumber(patterns, name);
if (isStatic && option == ImportOrderOption.BOTTOM) {
number += groups.length + 1;
}
else if (!isStatic && option == ImportOrderOption.TOP) {
number += staticGroups.length + 1;
}
return number;
}
/**
* Finds out what group the specified import belongs to.
*
* @param patterns groups to check.
* @param name the import name to find.
* @return group number for given import name.
*/
private static int getGroupNumber(Pattern[] patterns, String name) {
int bestIndex = patterns.length;
int bestEnd = -1;
int bestPos = Integer.MAX_VALUE;
// find out what group this belongs in
// loop over patterns and get index
for (int i = 0; i < patterns.length; i++) {
final Matcher matcher = patterns[i].matcher(name);
if (matcher.find()) {
if (matcher.start() < bestPos) {
bestIndex = i;
bestEnd = matcher.end();
bestPos = matcher.start();
}
else if (matcher.start() == bestPos && matcher.end() > bestEnd) {
bestIndex = i;
bestEnd = matcher.end();
}
}
}
return bestIndex;
}
/**
* Compares two strings.
*
* @param string1
* the first string.
* @param string2
* the second string.
* @param caseSensitive
* whether the comparison is case sensitive.
* @return the value {@code 0} if string1 is equal to string2; a value
* less than {@code 0} if string1 is lexicographically less
* than the string2; and a value greater than {@code 0} if
* string1 is lexicographically greater than string2.
*/
private static int compare(String string1, String string2,
boolean caseSensitive) {
final int result;
if (caseSensitive) {
result = string1.compareTo(string2);
}
else {
result = string1.compareToIgnoreCase(string2);
}
return result;
}
/**
* Compiles the list of package groups and the order they should occur in the file.
*
* @param packageGroups a comma-separated list of package names/prefixes.
* @return array of compiled patterns.
*/
private static Pattern[] compilePatterns(String... packageGroups) {
final Pattern[] patterns = new Pattern[packageGroups.length];
for (int i = 0; i < packageGroups.length; i++) {
String pkg = packageGroups[i];
final Pattern grp;
// if the pkg name is the wildcard, make it match zero chars
// from any name, so it will always be used as last resort.
if (WILDCARD_GROUP_NAME.equals(pkg)) {
// matches any package
grp = Pattern.compile("");
}
else if (CommonUtil.startsWithChar(pkg, '/')) {
if (!CommonUtil.endsWithChar(pkg, '/')) {
throw new IllegalArgumentException("Invalid group: " + pkg);
}
pkg = pkg.substring(1, pkg.length() - 1);
grp = Pattern.compile(pkg);
}
else {
final StringBuilder pkgBuilder = new StringBuilder(pkg);
if (!CommonUtil.endsWithChar(pkg, '.')) {
pkgBuilder.append('.');
}
grp = Pattern.compile("^" + Pattern.quote(pkgBuilder.toString()));
}
patterns[i] = grp;
}
return patterns;
}
}