forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CustomImportOrderCheck.java
1071 lines (992 loc) · 38.1 KB
/
CustomImportOrderCheck.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
988
989
990
991
992
993
994
995
996
997
998
999
1000
////////////////////////////////////////////////////////////////////////////////
// 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.ArrayList;
import java.util.List;
import java.util.StringTokenizer;
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 that the groups of import declarations appear in the order specified
* by the user. If there is an import but its group is not specified in the
* configuration such an import should be placed at the end of the import list.
* </p>
* <p>
* The rule consists of:
* </p>
* <ol>
* <li>
* STATIC group. This group sets the ordering of static imports.
* </li>
* <li>
* SAME_PACKAGE(n) group. This group sets the ordering of the same package imports.
* Imports are considered on SAME_PACKAGE group if <b>n</b> first domains in package
* name and import name are identical:
* <pre>
* package java.util.concurrent.locks;
*
* import java.io.File;
* import java.util.*; //#1
* import java.util.List; //#2
* import java.util.StringTokenizer; //#3
* import java.util.concurrent.*; //#4
* import java.util.concurrent.AbstractExecutorService; //#5
* import java.util.concurrent.locks.LockSupport; //#6
* import java.util.regex.Pattern; //#7
* import java.util.regex.Matcher; //#8
* </pre>
* If we have SAME_PACKAGE(3) on configuration file, imports #4-6 will be considered as
* a SAME_PACKAGE group (java.util.concurrent.*, java.util.concurrent.AbstractExecutorService,
* java.util.concurrent.locks.LockSupport). SAME_PACKAGE(2) will include #1-8.
* SAME_PACKAGE(4) will include only #6. SAME_PACKAGE(5) will result in no imports assigned
* to SAME_PACKAGE group because actual package java.util.concurrent.locks has only 4 domains.
* </li>
* <li>
* THIRD_PARTY_PACKAGE group. This group sets ordering of third party imports.
* Third party imports are all imports except STATIC, SAME_PACKAGE(n), STANDARD_JAVA_PACKAGE and
* SPECIAL_IMPORTS.
* </li>
* <li>
* STANDARD_JAVA_PACKAGE group. By default this group sets ordering of standard java/javax imports.
* </li>
* <li>
* SPECIAL_IMPORTS group. This group may contains some imports that have particular meaning for the
* user.
* </li>
* </ol>
* <p>
* Use the separator '###' between rules.
* </p>
* <p>
* To set RegExps for THIRD_PARTY_PACKAGE and STANDARD_JAVA_PACKAGE groups use
* thirdPartyPackageRegExp and standardPackageRegExp options.
* </p>
* <p>
* Pretty often one import can match more than one group. For example, static import from standard
* package or regular expressions are configured to allow one import match multiple groups.
* In this case, group will be assigned according to priorities:
* </p>
* <ol>
* <li>
* STATIC has top priority
* </li>
* <li>
* SAME_PACKAGE has second priority
* </li>
* <li>
* STANDARD_JAVA_PACKAGE and SPECIAL_IMPORTS will compete using "best match" rule: longer
* matching substring wins; in case of the same length, lower position of matching substring
* wins; if position is the same, order of rules in configuration solves the puzzle.
* </li>
* <li>
* THIRD_PARTY has the least priority
* </li>
* </ol>
* <p>
* Few examples to illustrate "best match":
* </p>
* <p>
* 1. patterns STANDARD_JAVA_PACKAGE = "Check", SPECIAL_IMPORTS="ImportOrderCheck" and input file:
* </p>
* <pre>
* import com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck;
* import com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck;
* </pre>
* <p>
* Result: imports will be assigned to SPECIAL_IMPORTS, because matching substring length is 16.
* Matching substring for STANDARD_JAVA_PACKAGE is 5.
* </p>
* <p>
* 2. patterns STANDARD_JAVA_PACKAGE = "Check", SPECIAL_IMPORTS="Avoid" and file:
* </p>
* <pre>
* import com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck;
* </pre>
* <p>
* Result: import will be assigned to SPECIAL_IMPORTS. Matching substring length is 5 for both
* patterns. However, "Avoid" position is lower than "Check" position.
* </p>
* <ul>
* <li>
* Property {@code customImportOrderRules} - Specify list of order declaration customizing by user.
* Default value is {@code {}}.
* </li>
* <li>
* Property {@code standardPackageRegExp} - Specify RegExp for STANDARD_JAVA_PACKAGE group imports.
* Default value is {@code "^(java|javax)\."}.
* </li>
* <li>
* Property {@code thirdPartyPackageRegExp} - Specify RegExp for THIRD_PARTY_PACKAGE group imports.
* Default value is {@code ".*"}.
* </li>
* <li>
* Property {@code specialImportsRegExp} - Specify RegExp for SPECIAL_IMPORTS group imports.
* Default value is {@code "^$" (empty)}.
* </li>
* <li>
* Property {@code separateLineBetweenGroups} - Force empty line separator between
* import groups.
* Default value is {@code true}.
* </li>
* <li>
* Property {@code sortImportsInGroupAlphabetically} - Force grouping alphabetically,
* in <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>.
* Default value is {@code false}.
* </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 non-static 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 single blank line
* </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="CustomImportOrder">
* <property name="customImportOrderRules"
* value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS"/>
* <property name="specialImportsRegExp" value="^org\."/>
* <property name="sortImportsInGroupAlphabetically" value="true"/>
* <property name="separateLineBetweenGroups" 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 non-static 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 one blank line
* </li>
* </ul>
* <pre>
* <module name="CustomImportOrder">
* <property name="customImportOrderRules"
* value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
* <property name="specialImportsRegExp" value="^org\."/>
* <property name="thirdPartyPackageRegExp" value="^com\."/>
* <property name="sortImportsInGroupAlphabetically" value="true"/>
* <property name="separateLineBetweenGroups" value="true"/>
* </module>
* </pre>
* <p>
* To configure the check so that it matches default IntelliJ IDEA formatter configuration
* (tested on v14):
* </p>
* <ul>
* <li>
* group of static imports is on the bottom
* </li>
* <li>
* groups of non-static 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 one blank line
* </li>
* </ul>
* <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="CustomImportOrder">
* <property name="customImportOrderRules"
* value="THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS###STANDARD_JAVA_PACKAGE###STATIC"/>
* <property name="specialImportsRegExp" value="^javax\."/>
* <property name="standardPackageRegExp" value="^java\."/>
* <property name="sortImportsInGroupAlphabetically" value="true"/>
* <property name="separateLineBetweenGroups" value="false"/>
* </module>
* </pre>
* <p>
* To configure the check so that it matches default NetBeans formatter configuration
* (tested on v8):
* </p>
* <ul>
* <li>
* groups of non-static 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="CustomImportOrder"/>
* </pre>
* <p>
* To set RegExps for THIRD_PARTY_PACKAGE and STANDARD_JAVA_PACKAGE groups use
* thirdPartyPackageRegExp and standardPackageRegExp options.
* </p>
* <pre>
* <module name="CustomImportOrder">
* <property name="customImportOrderRules"
* value="STATIC###SAME_PACKAGE(3)###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
* <property name="thirdPartyPackageRegExp" value="^(com|org)\."/>
* <property name="standardPackageRegExp" value="^(java|javax)\."/>
* </module>
* </pre>
* <p>
* Also, this check can be configured to force empty line separator between
* import groups. For example.
* </p>
* <pre>
* <module name="CustomImportOrder">
* <property name="separateLineBetweenGroups" value="true"/>
* </module>
* </pre>
* <p>
* It is possible to enforce
* <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>
* of imports in groups using the following configuration:
* </p>
* <pre>
* <module name="CustomImportOrder">
* <property name="sortImportsInGroupAlphabetically" value="true"/>
* </module>
* </pre>
* <p>
* Example of ASCII order:
* </p>
* <pre>
* import java.awt.Dialog;
* import java.awt.Window;
* import java.awt.color.ColorSpace;
* import java.awt.Frame; // violation here - in ASCII order 'F' should go before 'c',
* // as all uppercase come before lowercase letters
* </pre>
* <p>
* To force checking imports sequence such as:
* </p>
* <pre>
* package com.puppycrawl.tools.checkstyle.imports;
*
* import com.google.common.annotations.GwtCompatible;
* import com.google.common.annotations.Beta;
* import com.google.common.annotations.VisibleForTesting;
*
* import org.abego.treelayout.Configuration;
*
* import static sun.tools.util.ModifierFilter.ALL_ACCESS;
*
* import com.google.common.annotations.GwtCompatible; // violation here - should be in the
* // THIRD_PARTY_PACKAGE group
* import android.*;
* </pre>
* <p>
* configure as follows:
* </p>
* <pre>
* <module name="CustomImportOrder">
* <property name="customImportOrderRules"
* value="SAME_PACKAGE(3)###THIRD_PARTY_PACKAGE###STATIC###SPECIAL_IMPORTS"/>
* <property name="specialImportsRegExp" value="^android\."/>
* </module>
* </pre>
*
* @since 5.8
*/
@FileStatefulCheck
public class CustomImportOrderCheck extends AbstractCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_LINE_SEPARATOR = "custom.import.order.line.separator";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_SEPARATED_IN_GROUP = "custom.import.order.separated.internally";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_LEX = "custom.import.order.lex";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_NONGROUP_IMPORT = "custom.import.order.nonGroup.import";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_NONGROUP_EXPECTED = "custom.import.order.nonGroup.expected";
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_ORDER = "custom.import.order";
/** STATIC group name. */
public static final String STATIC_RULE_GROUP = "STATIC";
/** SAME_PACKAGE group name. */
public static final String SAME_PACKAGE_RULE_GROUP = "SAME_PACKAGE";
/** THIRD_PARTY_PACKAGE group name. */
public static final String THIRD_PARTY_PACKAGE_RULE_GROUP = "THIRD_PARTY_PACKAGE";
/** STANDARD_JAVA_PACKAGE group name. */
public static final String STANDARD_JAVA_PACKAGE_RULE_GROUP = "STANDARD_JAVA_PACKAGE";
/** SPECIAL_IMPORTS group name. */
public static final String SPECIAL_IMPORTS_RULE_GROUP = "SPECIAL_IMPORTS";
/** NON_GROUP group name. */
private static final String NON_GROUP_RULE_GROUP = "NOT_ASSIGNED_TO_ANY_GROUP";
/** Pattern used to separate groups of imports. */
private static final Pattern GROUP_SEPARATOR_PATTERN = Pattern.compile("\\s*###\\s*");
/** Specify list of order declaration customizing by user. */
private final List<String> customImportOrderRules = new ArrayList<>();
/** Contains objects with import attributes. */
private final List<ImportDetails> importToGroupList = new ArrayList<>();
/** Specify RegExp for SAME_PACKAGE group imports. */
private String samePackageDomainsRegExp = "";
/** Specify RegExp for STANDARD_JAVA_PACKAGE group imports. */
private Pattern standardPackageRegExp = Pattern.compile("^(java|javax)\\.");
/** Specify RegExp for THIRD_PARTY_PACKAGE group imports. */
private Pattern thirdPartyPackageRegExp = Pattern.compile(".*");
/** Specify RegExp for SPECIAL_IMPORTS group imports. */
private Pattern specialImportsRegExp = Pattern.compile("^$");
/** Force empty line separator between import groups. */
private boolean separateLineBetweenGroups = true;
/**
* Force grouping alphabetically,
* in <a href="https://en.wikipedia.org/wiki/ASCII#Order"> ASCII sort order</a>.
*/
private boolean sortImportsInGroupAlphabetically;
/** Number of first domains for SAME_PACKAGE group. */
private int samePackageMatchingDepth = 2;
/**
* Setter to specify RegExp for STANDARD_JAVA_PACKAGE group imports.
* @param regexp
* user value.
*/
public final void setStandardPackageRegExp(Pattern regexp) {
standardPackageRegExp = regexp;
}
/**
* Setter to specify RegExp for THIRD_PARTY_PACKAGE group imports.
* @param regexp
* user value.
*/
public final void setThirdPartyPackageRegExp(Pattern regexp) {
thirdPartyPackageRegExp = regexp;
}
/**
* Setter to specify RegExp for SPECIAL_IMPORTS group imports.
* @param regexp
* user value.
*/
public final void setSpecialImportsRegExp(Pattern regexp) {
specialImportsRegExp = regexp;
}
/**
* Setter to force empty line separator between import groups.
* @param value
* user value.
*/
public final void setSeparateLineBetweenGroups(boolean value) {
separateLineBetweenGroups = value;
}
/**
* Setter to force grouping alphabetically, in
* <a href="https://en.wikipedia.org/wiki/ASCII#Order">ASCII sort order</a>.
* @param value
* user value.
*/
public final void setSortImportsInGroupAlphabetically(boolean value) {
sortImportsInGroupAlphabetically = value;
}
/**
* Setter to specify list of order declaration customizing by user.
* @param inputCustomImportOrder
* user value.
*/
public final void setCustomImportOrderRules(final String inputCustomImportOrder) {
for (String currentState : GROUP_SEPARATOR_PATTERN.split(inputCustomImportOrder)) {
addRulesToList(currentState);
}
customImportOrderRules.add(NON_GROUP_RULE_GROUP);
}
@Override
public int[] getDefaultTokens() {
return getRequiredTokens();
}
@Override
public int[] getAcceptableTokens() {
return getRequiredTokens();
}
@Override
public int[] getRequiredTokens() {
return new int[] {
TokenTypes.IMPORT,
TokenTypes.STATIC_IMPORT,
TokenTypes.PACKAGE_DEF,
};
}
@Override
public void beginTree(DetailAST rootAST) {
importToGroupList.clear();
}
@Override
public void visitToken(DetailAST ast) {
if (ast.getType() == TokenTypes.PACKAGE_DEF) {
samePackageDomainsRegExp = createSamePackageRegexp(
samePackageMatchingDepth, ast);
}
else {
final String importFullPath = getFullImportIdent(ast);
final int lineNo = ast.getLineNo();
final int endLineNo = ast.getLastChild().getLineNo();
final boolean isStatic = ast.getType() == TokenTypes.STATIC_IMPORT;
importToGroupList.add(new ImportDetails(importFullPath,
lineNo, endLineNo, getImportGroup(isStatic, importFullPath),
isStatic));
}
}
@Override
public void finishTree(DetailAST rootAST) {
if (!importToGroupList.isEmpty()) {
finishImportList();
}
}
/** Examine the order of all the imports and log any violations. */
private void finishImportList() {
String currentGroup = getFirstGroup();
int currentGroupNumber = customImportOrderRules.indexOf(currentGroup);
ImportDetails previousImportObjectFromCurrentGroup = null;
String previousImportFromCurrentGroup = null;
for (ImportDetails importObject : importToGroupList) {
final String importGroup = importObject.getImportGroup();
final String fullImportIdent = importObject.getImportFullPath();
if (importGroup.equals(currentGroup)) {
validateExtraEmptyLine(previousImportObjectFromCurrentGroup,
importObject, fullImportIdent);
if (isAlphabeticalOrderBroken(previousImportFromCurrentGroup, fullImportIdent)) {
log(importObject.getStartLineNumber(), MSG_LEX,
fullImportIdent, previousImportFromCurrentGroup);
}
else {
previousImportFromCurrentGroup = fullImportIdent;
}
previousImportObjectFromCurrentGroup = importObject;
}
else {
// not the last group, last one is always NON_GROUP
if (customImportOrderRules.size() > currentGroupNumber + 1) {
final String nextGroup = getNextImportGroup(currentGroupNumber + 1);
if (importGroup.equals(nextGroup)) {
validateMissedEmptyLine(previousImportObjectFromCurrentGroup,
importObject, fullImportIdent);
currentGroup = nextGroup;
currentGroupNumber = customImportOrderRules.indexOf(nextGroup);
previousImportFromCurrentGroup = fullImportIdent;
}
else {
logWrongImportGroupOrder(importObject.getStartLineNumber(),
importGroup, nextGroup, fullImportIdent);
}
previousImportObjectFromCurrentGroup = importObject;
}
else {
logWrongImportGroupOrder(importObject.getStartLineNumber(),
importGroup, currentGroup, fullImportIdent);
}
}
}
}
/**
* Log violation if empty line is missed.
* @param previousImport previous import from current group.
* @param importObject current import.
* @param fullImportIdent full import identifier.
*/
private void validateMissedEmptyLine(ImportDetails previousImport,
ImportDetails importObject, String fullImportIdent) {
if (isEmptyLineMissed(previousImport, importObject)) {
log(importObject.getStartLineNumber(), MSG_LINE_SEPARATOR, fullImportIdent);
}
}
/**
* Log violation if extra empty line is present.
* @param previousImport previous import from current group.
* @param importObject current import.
* @param fullImportIdent full import identifier.
*/
private void validateExtraEmptyLine(ImportDetails previousImport,
ImportDetails importObject, String fullImportIdent) {
if (isSeparatedByExtraEmptyLine(previousImport, importObject)) {
log(importObject.getStartLineNumber(), MSG_SEPARATED_IN_GROUP, fullImportIdent);
}
}
/**
* Get first import group.
*
* @return
* first import group of file.
*/
private String getFirstGroup() {
final ImportDetails firstImport = importToGroupList.get(0);
return getImportGroup(firstImport.isStaticImport(),
firstImport.getImportFullPath());
}
/**
* Examine alphabetical order of imports.
*
* @param previousImport
* previous import of current group.
* @param currentImport
* current import.
* @return
* true, if previous and current import are not in alphabetical order.
*/
private boolean isAlphabeticalOrderBroken(String previousImport,
String currentImport) {
return sortImportsInGroupAlphabetically
&& previousImport != null
&& compareImports(currentImport, previousImport) < 0;
}
/**
* Examine empty lines between groups.
*
* @param previousImportObject
* previous import in current group.
* @param currentImportObject
* current import.
* @return
* true, if current import NOT separated from previous import by empty line.
*/
private boolean isEmptyLineMissed(ImportDetails previousImportObject,
ImportDetails currentImportObject) {
return separateLineBetweenGroups
&& getCountOfEmptyLinesBetween(
previousImportObject.getEndLineNumber(),
currentImportObject.getStartLineNumber()) != 1;
}
/**
* Examine that imports separated by more than one empty line.
*
* @param previousImportObject
* previous import in current group.
* @param currentImportObject
* current import.
* @return
* true, if current import separated from previous by more that one empty line.
*/
private boolean isSeparatedByExtraEmptyLine(ImportDetails previousImportObject,
ImportDetails currentImportObject) {
return previousImportObject != null
&& getCountOfEmptyLinesBetween(
previousImportObject.getEndLineNumber(),
currentImportObject.getStartLineNumber()) > 0;
}
/**
* Log wrong import group order.
* @param currentImportLine
* line number of current import current import.
* @param importGroup
* import group.
* @param currentGroupNumber
* current group number we are checking.
* @param fullImportIdent
* full import name.
*/
private void logWrongImportGroupOrder(int currentImportLine, String importGroup,
String currentGroupNumber, String fullImportIdent) {
if (NON_GROUP_RULE_GROUP.equals(importGroup)) {
log(currentImportLine, MSG_NONGROUP_IMPORT, fullImportIdent);
}
else if (NON_GROUP_RULE_GROUP.equals(currentGroupNumber)) {
log(currentImportLine, MSG_NONGROUP_EXPECTED, importGroup, fullImportIdent);
}
else {
log(currentImportLine, MSG_ORDER, importGroup, currentGroupNumber, fullImportIdent);
}
}
/**
* Get next import group.
* @param currentGroupNumber
* current group number.
* @return
* next import group.
*/
private String getNextImportGroup(int currentGroupNumber) {
int nextGroupNumber = currentGroupNumber;
while (customImportOrderRules.size() > nextGroupNumber + 1) {
if (hasAnyImportInCurrentGroup(customImportOrderRules.get(nextGroupNumber))) {
break;
}
nextGroupNumber++;
}
return customImportOrderRules.get(nextGroupNumber);
}
/**
* Checks if current group contains any import.
* @param currentGroup
* current group.
* @return
* true, if current group contains at least one import.
*/
private boolean hasAnyImportInCurrentGroup(String currentGroup) {
boolean result = false;
for (ImportDetails currentImport : importToGroupList) {
if (currentGroup.equals(currentImport.getImportGroup())) {
result = true;
break;
}
}
return result;
}
/**
* Get import valid group.
* @param isStatic
* is static import.
* @param importPath
* full import path.
* @return import valid group.
*/
private String getImportGroup(boolean isStatic, String importPath) {
RuleMatchForImport bestMatch = new RuleMatchForImport(NON_GROUP_RULE_GROUP, 0, 0);
if (isStatic && customImportOrderRules.contains(STATIC_RULE_GROUP)) {
bestMatch.group = STATIC_RULE_GROUP;
bestMatch.matchLength = importPath.length();
}
else if (customImportOrderRules.contains(SAME_PACKAGE_RULE_GROUP)) {
final String importPathTrimmedToSamePackageDepth =
getFirstDomainsFromIdent(samePackageMatchingDepth, importPath);
if (samePackageDomainsRegExp.equals(importPathTrimmedToSamePackageDepth)) {
bestMatch.group = SAME_PACKAGE_RULE_GROUP;
bestMatch.matchLength = importPath.length();
}
}
if (bestMatch.group.equals(NON_GROUP_RULE_GROUP)) {
for (String group : customImportOrderRules) {
if (STANDARD_JAVA_PACKAGE_RULE_GROUP.equals(group)) {
bestMatch = findBetterPatternMatch(importPath,
STANDARD_JAVA_PACKAGE_RULE_GROUP, standardPackageRegExp, bestMatch);
}
if (SPECIAL_IMPORTS_RULE_GROUP.equals(group)) {
bestMatch = findBetterPatternMatch(importPath,
group, specialImportsRegExp, bestMatch);
}
}
}
if (bestMatch.group.equals(NON_GROUP_RULE_GROUP)
&& customImportOrderRules.contains(THIRD_PARTY_PACKAGE_RULE_GROUP)
&& thirdPartyPackageRegExp.matcher(importPath).find()) {
bestMatch.group = THIRD_PARTY_PACKAGE_RULE_GROUP;
}
return bestMatch.group;
}
/**
* Tries to find better matching regular expression:
* longer matching substring wins; in case of the same length,
* lower position of matching substring wins.
*
* @param importPath
* Full import identifier
* @param group
* Import group we are trying to assign the import
* @param regExp
* Regular expression for import group
* @param currentBestMatch
* object with currently best match
* @return better match (if found) or the same (currentBestMatch)
*/
private static RuleMatchForImport findBetterPatternMatch(String importPath, String group,
Pattern regExp, RuleMatchForImport currentBestMatch) {
RuleMatchForImport betterMatchCandidate = currentBestMatch;
final Matcher matcher = regExp.matcher(importPath);
while (matcher.find()) {
final int length = matcher.end() - matcher.start();
if (length > betterMatchCandidate.matchLength
|| length == betterMatchCandidate.matchLength
&& matcher.start() < betterMatchCandidate.matchPosition) {
betterMatchCandidate = new RuleMatchForImport(group, length, matcher.start());
}
}
return betterMatchCandidate;
}
/**
* Checks compare two import paths.
* @param import1
* current import.
* @param import2
* previous import.
* @return a negative integer, zero, or a positive integer as the
* specified String is greater than, equal to, or less
* than this String, ignoring case considerations.
*/
private static int compareImports(String import1, String import2) {
int result = 0;
final String separator = "\\.";
final String[] import1Tokens = import1.split(separator);
final String[] import2Tokens = import2.split(separator);
for (int i = 0; i != import1Tokens.length && i != import2Tokens.length; i++) {
final String import1Token = import1Tokens[i];
final String import2Token = import2Tokens[i];
result = import1Token.compareTo(import2Token);
if (result != 0) {
break;
}
}
if (result == 0) {
result = Integer.compare(import1Tokens.length, import2Tokens.length);
}
return result;
}
/**
* Counts empty lines between given parameters.
* @param fromLineNo
* One-based line number of previous import.
* @param toLineNo
* One-based line number of current import.
* @return count of empty lines between given parameters, exclusive,
* eg., (fromLineNo, toLineNo).
*/
private int getCountOfEmptyLinesBetween(int fromLineNo, int toLineNo) {
int result = 0;
final String[] lines = getLines();
for (int i = fromLineNo + 1; i <= toLineNo - 1; i++) {
// "- 1" because the numbering is one-based
if (CommonUtil.isBlank(lines[i - 1])) {
result++;
}
}
return result;
}
/**
* Forms import full path.
* @param token
* current token.
* @return full path or null.
*/
private static String getFullImportIdent(DetailAST token) {
String ident = "";
if (token != null) {
ident = FullIdent.createFullIdent(token.findFirstToken(TokenTypes.DOT)).getText();
}
return ident;
}
/**
* Parses ordering rule and adds it to the list with rules.
* @param ruleStr
* String with rule.
* @throws IllegalArgumentException when SAME_PACKAGE rule parameter is not positive integer
* @throws IllegalStateException when ruleStr is unexpected value
*/
private void addRulesToList(String ruleStr) {
if (STATIC_RULE_GROUP.equals(ruleStr)
|| THIRD_PARTY_PACKAGE_RULE_GROUP.equals(ruleStr)
|| STANDARD_JAVA_PACKAGE_RULE_GROUP.equals(ruleStr)
|| SPECIAL_IMPORTS_RULE_GROUP.equals(ruleStr)) {
customImportOrderRules.add(ruleStr);
}
else if (ruleStr.startsWith(SAME_PACKAGE_RULE_GROUP)) {
final String rule = ruleStr.substring(ruleStr.indexOf('(') + 1,
ruleStr.indexOf(')'));
samePackageMatchingDepth = Integer.parseInt(rule);
if (samePackageMatchingDepth <= 0) {
throw new IllegalArgumentException(
"SAME_PACKAGE rule parameter should be positive integer: " + ruleStr);
}
customImportOrderRules.add(SAME_PACKAGE_RULE_GROUP);
}
else {
throw new IllegalStateException("Unexpected rule: " + ruleStr);
}
}
/**
* Creates samePackageDomainsRegExp of the first package domains.
* @param firstPackageDomainsCount
* number of first package domains.
* @param packageNode
* package node.
* @return same package regexp.
*/
private static String createSamePackageRegexp(int firstPackageDomainsCount,
DetailAST packageNode) {
final String packageFullPath = getFullImportIdent(packageNode);
return getFirstDomainsFromIdent(firstPackageDomainsCount, packageFullPath);
}
/**
* Extracts defined amount of domains from the left side of package/import identifier.
* @param firstPackageDomainsCount
* number of first package domains.
* @param packageFullPath
* full identifier containing path to package or imported object.
* @return String with defined amount of domains or full identifier
* (if full identifier had less domain than specified)
*/
private static String getFirstDomainsFromIdent(
final int firstPackageDomainsCount, final String packageFullPath) {
final StringBuilder builder = new StringBuilder(256);
final StringTokenizer tokens = new StringTokenizer(packageFullPath, ".");
int count = firstPackageDomainsCount;
while (count > 0 && tokens.hasMoreTokens()) {
builder.append(tokens.nextToken()).append('.');
count--;
}
return builder.toString();
}
/**
* Contains import attributes as line number, import full path, import
* group.
*/
private static class ImportDetails {
/** Import full path. */
private final String importFullPath;
/** Import start line number. */
private final int startLineNumber;
/**
* Import end line number.
* Note: It can be different from <b>startLineNumber</b> when import statement span
* multiple lines.
*/
private final int endLineNumber;
/** Import group. */
private final String importGroup;
/** Is static import. */
private final boolean staticImport;
/**
* Initialise importFullPath, startLineNumber, endLineNumber, importGroup, staticImport.
* @param importFullPath
* import full path.
* @param startLineNumber
* import start line number.
* @param endLineNumber
* import end line number.
* @param importGroup
* import group.
* @param staticImport
* if import is static.
*/
/* package */ ImportDetails(String importFullPath, int startLineNumber, int endLineNumber,
String importGroup, boolean staticImport) {
this.importFullPath = importFullPath;
this.startLineNumber = startLineNumber;
this.endLineNumber = endLineNumber;
this.importGroup = importGroup;
this.staticImport = staticImport;
}
/**
* Get import full path variable.
* @return import full path variable.