-
Notifications
You must be signed in to change notification settings - Fork 56
/
ApiErrorsWarningsConfigurationBlock.java
1610 lines (1488 loc) · 66.3 KB
/
ApiErrorsWarningsConfigurationBlock.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
/*******************************************************************************
* Copyright (c) 2007, 2022 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.pde.api.tools.ui.internal.preferences;
import java.net.URL;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.core.commands.Command;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.commands.NotEnabledException;
import org.eclipse.core.commands.NotHandledException;
import org.eclipse.core.commands.common.NotDefinedException;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.ProjectScope;
import org.eclipse.core.runtime.preferences.DefaultScope;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.IScopeContext;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.window.Window;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.api.tools.internal.model.StubApiComponent;
import org.eclipse.pde.api.tools.internal.provisional.ApiPlugin;
import org.eclipse.pde.api.tools.internal.provisional.ProfileModifiers;
import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes;
import org.eclipse.pde.api.tools.internal.util.Util;
import org.eclipse.pde.api.tools.ui.internal.ApiUIPlugin;
import org.eclipse.pde.api.tools.ui.internal.SWTFactory;
import org.eclipse.pde.internal.ui.preferences.ConfigurationBlock;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.ScrolledComposite;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.FontMetrics;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Link;
import org.eclipse.swt.widgets.TabFolder;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.commands.ICommandService;
import org.eclipse.ui.forms.events.ExpansionAdapter;
import org.eclipse.ui.forms.events.ExpansionEvent;
import org.eclipse.ui.forms.widgets.ExpandableComposite;
import org.eclipse.ui.handlers.IHandlerService;
import org.eclipse.ui.preferences.IWorkbenchPreferenceContainer;
import org.eclipse.ui.preferences.IWorkingCopyManager;
import org.eclipse.ui.preferences.WorkingCopyManager;
import org.osgi.service.prefs.BackingStoreException;
/**
* This block is used to add the API Tools notification settings UI to a parent
* control
*
* @since 1.0.0
*/
public class ApiErrorsWarningsConfigurationBlock extends ConfigurationBlock {
public static final String P2_INSTALL_COMMAND_HANDLER = "org.eclipse.equinox.p2.ui.sdk.install"; //$NON-NLS-1$
/**
* Provides data information for created controls
*/
protected static class ControlData {
private final Key key;
private final String[] values;
/**
* Constructor
*/
public ControlData(Key key, String[] values) {
this.key = key;
this.values = values;
}
public Key getKey() {
return key;
}
public String getValue(boolean selection) {
int index = selection ? 0 : 1;
return values[index];
}
public String getValue(int index) {
return values[index];
}
public int getSelection(String value) {
if (value != null) {
for (int i = 0; i < values.length; i++) {
if (value.equals(values[i])) {
return i;
}
}
}
return values.length - 1; // assume the last option is the least
// severe
}
}
/**
* Provides management for changed/stored values for a given preference key
*/
public static class Key {
private final String qualifier;
private final String key;
/**
* Constructor
*/
public Key(String qualifier, String key) {
this.qualifier = qualifier;
this.key = key;
}
public String getQualifier() {
return qualifier;
}
public String getName() {
return key;
}
/**
* Returns the {@link IEclipsePreferences} node for the given context
* and {@link IWorkingCopyManager}
*
* @return the {@link IEclipsePreferences} node or <code>null</code>
*/
private IEclipsePreferences getNode(IScopeContext context, IWorkingCopyManager manager) {
IEclipsePreferences node = context.getNode(qualifier);
if (manager != null) {
return manager.getWorkingCopy(node);
}
return node;
}
/**
* Returns the value stored in the {@link IEclipsePreferences} node from
* the given context and working copy manager
*
* @return the value from the {@link IEclipsePreferences} node or
* <code>null</code>
*/
public String getStoredValue(IScopeContext context, IWorkingCopyManager manager) {
IEclipsePreferences node = getNode(context, manager);
if (node != null) {
return node.get(key, null);
}
return null;
}
/**
* Returns the stored value of this {@link IEclipsePreferences} node
* using a given lookup order, and allowing the top scope to be ignored
*
* @return the value from the {@link IEclipsePreferences} node or
* <code>null</code>
*/
public String getStoredValue(IScopeContext[] lookupOrder, boolean ignoreTopScope, IWorkingCopyManager manager) {
for (int i = ignoreTopScope ? 1 : 0; i < lookupOrder.length; i++) {
String value = getStoredValue(lookupOrder[i], manager);
if (value != null) {
return value;
}
}
return null;
}
/**
* Sets the value of this key
*/
public void setStoredValue(IScopeContext context, String value, IWorkingCopyManager manager) {
IEclipsePreferences node = getNode(context, manager);
if (value != null) {
node.put(key, value);
} else {
node.remove(key);
}
}
@Override
public String toString() {
return qualifier + '/' + key;
}
}
/**
* Returns a new {@link Key} for the {@link ApiUIPlugin} preference store
*
* @return the new {@link Key} for the {@link ApiUIPlugin} preference store
*/
protected final static Key getApiToolsKey(String key) {
return new Key(ApiPlugin.PLUGIN_ID, key);
}
// Restriction modifier keys
private static final Key KEY_NOIMPLEMENT = getApiToolsKey(IApiProblemTypes.ILLEGAL_IMPLEMENT);
private static final Key KEY_NOEXTEND = getApiToolsKey(IApiProblemTypes.ILLEGAL_EXTEND);
private static final Key KEY_NOINSTANTIATE = getApiToolsKey(IApiProblemTypes.ILLEGAL_INSTANTIATE);
private static final Key KEY_NOREFERENCE = getApiToolsKey(IApiProblemTypes.ILLEGAL_REFERENCE);
private static final Key KEY_NOOVERRIDE = getApiToolsKey(IApiProblemTypes.ILLEGAL_OVERRIDE);
private static final Key KEY_LEAK_EXTEND = getApiToolsKey(IApiProblemTypes.LEAK_EXTEND);
private static final Key KEY_LEAK_IMPLEMENT = getApiToolsKey(IApiProblemTypes.LEAK_IMPLEMENT);
private static final Key KEY_LEAK_METHOD_RETURN_TYPE = getApiToolsKey(IApiProblemTypes.LEAK_METHOD_RETURN_TYPE);
private static final Key KEY_LEAK_FIELD_DECL = getApiToolsKey(IApiProblemTypes.LEAK_FIELD_DECL);
private static final Key KEY_LEAK_METHOD_PARAM = getApiToolsKey(IApiProblemTypes.LEAK_METHOD_PARAM);
private static final Key KEY_INVALID_JAVADOC_TAG = getApiToolsKey(IApiProblemTypes.INVALID_JAVADOC_TAG);
private static final Key KEY_INVALID_ANNOTATION = getApiToolsKey(IApiProblemTypes.INVALID_ANNOTATION);
private static final Key KEY_INVALID_REFERENCE_IN_SYSTEM_LIBRARIES = getApiToolsKey(IApiProblemTypes.INVALID_REFERENCE_IN_SYSTEM_LIBRARIES);
private static final Key KEY_UNUSED_PROBLEM_FILTERS = getApiToolsKey(IApiProblemTypes.UNUSED_PROBLEM_FILTERS);
// compatibility keys
private static final Key KEY_API_COMPONENT_REMOVED_API_TYPE = getApiToolsKey(IApiProblemTypes.API_COMPONENT_REMOVED_API_TYPE);
private static final Key KEY_API_COMPONENT_REMOVED_TYPE = getApiToolsKey(IApiProblemTypes.API_COMPONENT_REMOVED_TYPE);
private static final Key KEY_API_COMPONENT_REMOVED_REEXPORTED_API_TYPE = getApiToolsKey(IApiProblemTypes.API_COMPONENT_REMOVED_REEXPORTED_API_TYPE);
private static final Key KEY_API_COMPONENT_REMOVED_REEXPORTED_TYPE = getApiToolsKey(IApiProblemTypes.API_COMPONENT_REMOVED_REEXPORTED_TYPE);
private static final Key KEY_ANNOTATION_ADDED_METHOD_NO_DEFAULT_VALUE = getApiToolsKey(IApiProblemTypes.ANNOTATION_ADDED_METHOD_NO_DEFAULT_VALUE);
private static final Key KEY_ANNOTATION_ADDED_FIELD = getApiToolsKey(IApiProblemTypes.ANNOTATION_ADDED_FIELD);
private static final Key KEY_ANNOTATION_REMOVED_FIELD = getApiToolsKey(IApiProblemTypes.ANNOTATION_REMOVED_FIELD);
private static final Key KEY_ANNOTATION_REMOVED_METHOD = getApiToolsKey(IApiProblemTypes.ANNOTATION_REMOVED_METHOD);
private static final Key KEY_ANNOTATION_REMOVED_TYPE_MEMBER = getApiToolsKey(IApiProblemTypes.ANNOTATION_REMOVED_TYPE_MEMBER);
private static final Key KEY_ANNOTATION_CHANGED_TYPE_CONVERSION = getApiToolsKey(IApiProblemTypes.ANNOTATION_CHANGED_TYPE_CONVERSION);
// interface key constant
private static final Key KEY_INTERFACE_ADDED_FIELD = getApiToolsKey(IApiProblemTypes.INTERFACE_ADDED_FIELD);
private static final Key KEY_INTERFACE_ADDED_METHOD = getApiToolsKey(IApiProblemTypes.INTERFACE_ADDED_METHOD);
private static final Key KEY_INTERFACE_ADDED_DEFAULT_METHOD = getApiToolsKey(IApiProblemTypes.INTERFACE_ADDED_DEFAULT_METHOD);
private static final Key KEY_INTERFACE_ADDED_RESTRICTIONS = getApiToolsKey(IApiProblemTypes.INTERFACE_ADDED_RESTRICTIONS);
private static final Key KEY_INTERFACE_ADDED_SUPER_INTERFACE_WITH_METHODS = getApiToolsKey(IApiProblemTypes.INTERFACE_ADDED_SUPER_INTERFACE_WITH_METHODS);
private static final Key KEY_INTERFACE_ADDED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.INTERFACE_ADDED_TYPE_PARAMETER);
private static final Key KEY_INTERFACE_REMOVED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.INTERFACE_REMOVED_TYPE_PARAMETER);
private static final Key KEY_INTERFACE_REMOVED_FIELD = getApiToolsKey(IApiProblemTypes.INTERFACE_REMOVED_FIELD);
private static final Key KEY_INTERFACE_REMOVED_METHOD = getApiToolsKey(IApiProblemTypes.INTERFACE_REMOVED_METHOD);
private static final Key KEY_INTERFACE_REMOVED_TYPE_MEMBER = getApiToolsKey(IApiProblemTypes.INTERFACE_REMOVED_TYPE_MEMBER);
private static final Key KEY_INTERFACE_CHANGED_TYPE_CONVERSION = getApiToolsKey(IApiProblemTypes.INTERFACE_CHANGED_TYPE_CONVERSION);
private static final Key KEY_INTERFACE_CHANGED_CONTRACTED_SUPERINTERFACES_SET = getApiToolsKey(IApiProblemTypes.INTERFACE_CHANGED_CONTRACTED_SUPERINTERFACES_SET);
// enum key constant
private static final Key KEY_ENUM_CHANGED_CONTRACTED_SUPERINTERFACES_SET = getApiToolsKey(IApiProblemTypes.ENUM_CHANGED_CONTRACTED_SUPERINTERFACES_SET);
private static final Key KEY_ENUM_CHANGED_TYPE_CONVERSION = getApiToolsKey(IApiProblemTypes.ENUM_CHANGED_TYPE_CONVERSION);
private static final Key KEY_ENUM_REMOVED_FIELD = getApiToolsKey(IApiProblemTypes.ENUM_REMOVED_FIELD);
private static final Key KEY_ENUM_REMOVED_ENUM_CONSTANT = getApiToolsKey(IApiProblemTypes.ENUM_REMOVED_ENUM_CONSTANT);
private static final Key KEY_ENUM_REMOVED_METHOD = getApiToolsKey(IApiProblemTypes.ENUM_REMOVED_METHOD);
private static final Key KEY_ENUM_REMOVED_TYPE_MEMBER = getApiToolsKey(IApiProblemTypes.ENUM_REMOVED_TYPE_MEMBER);
// class key constant
private static final Key KEY_CLASS_ADDED_FIELD = getApiToolsKey(IApiProblemTypes.CLASS_ADDED_FIELD);
private static final Key KEY_CLASS_ADDED_METHOD = getApiToolsKey(IApiProblemTypes.CLASS_ADDED_METHOD);
private static final Key KEY_CLASS_ADDED_RESTRICTIONS = getApiToolsKey(IApiProblemTypes.CLASS_ADDED_RESTRICTIONS);
private static final Key KEY_CLASS_ADDED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.CLASS_ADDED_TYPE_PARAMETER);
private static final Key KEY_CLASS_CHANGED_CONTRACTED_SUPERINTERFACES_SET = getApiToolsKey(IApiProblemTypes.CLASS_CHANGED_CONTRACTED_SUPERINTERFACES_SET);
private static final Key KEY_CLASS_CHANGED_NON_ABSTRACT_TO_ABSTRACT = getApiToolsKey(IApiProblemTypes.CLASS_CHANGED_NON_ABSTRACT_TO_ABSTRACT);
private static final Key KEY_CLASS_CHANGED_NON_FINAL_TO_FINAL = getApiToolsKey(IApiProblemTypes.CLASS_CHANGED_NON_FINAL_TO_FINAL);
private static final Key KEY_CLASS_CHANGED_TYPE_CONVERSION = getApiToolsKey(IApiProblemTypes.CLASS_CHANGED_TYPE_CONVERSION);
private static final Key KEY_CLASS_CHANGED_DECREASE_ACCESS = getApiToolsKey(IApiProblemTypes.CLASS_CHANGED_DECREASE_ACCESS);
private static final Key KEY_CLASS_REMOVED_FIELD = getApiToolsKey(IApiProblemTypes.CLASS_REMOVED_FIELD);
private static final Key KEY_CLASS_REMOVED_METHOD = getApiToolsKey(IApiProblemTypes.CLASS_REMOVED_METHOD);
private static final Key KEY_CLASS_REMOVED_CONSTRUCTOR = getApiToolsKey(IApiProblemTypes.CLASS_REMOVED_CONSTRUCTOR);
private static final Key KEY_CLASS_REMOVED_SUPERCLASS = getApiToolsKey(IApiProblemTypes.CLASS_REMOVED_SUPERCLASS);
private static final Key KEY_CLASS_REMOVED_TYPE_MEMBER = getApiToolsKey(IApiProblemTypes.CLASS_REMOVED_TYPE_MEMBER);
private static final Key KEY_CLASS_REMOVED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.CLASS_REMOVED_TYPE_PARAMETER);
// field key constant
private static final Key KEY_FIELD_ADDED_VALUE = getApiToolsKey(IApiProblemTypes.FIELD_ADDED_VALUE);
private static final Key KEY_FIELD_CHANGED_TYPE = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_TYPE);
private static final Key KEY_FIELD_CHANGED_VALUE = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_VALUE);
private static final Key KEY_FIELD_CHANGED_DECREASE_ACCESS = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_DECREASE_ACCESS);
private static final Key KEY_FIELD_CHANGED_FINAL_TO_NON_FINAL_STATIC_CONSTANT = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_FINAL_TO_NON_FINAL_STATIC_CONSTANT);
private static final Key KEY_FIELD_CHANGED_NON_FINAL_TO_FINAL = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_NON_FINAL_TO_FINAL);
private static final Key KEY_FIELD_CHANGED_STATIC_TO_NON_STATIC = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_STATIC_TO_NON_STATIC);
private static final Key KEY_FIELD_CHANGED_NON_STATIC_TO_STATIC = getApiToolsKey(IApiProblemTypes.FIELD_CHANGED_NON_STATIC_TO_STATIC);
private static final Key KEY_FIELD_REMOVED_VALUE = getApiToolsKey(IApiProblemTypes.FIELD_REMOVED_VALUE);
private static final Key KEY_FIELD_REMOVED_TYPE_ARGUMENT = getApiToolsKey(IApiProblemTypes.FIELD_REMOVED_TYPE_ARGUMENT);
// method key constant
private static final Key KEY_METHOD_ADDED_RESTRICTIONS = getApiToolsKey(IApiProblemTypes.METHOD_ADDED_RESTRICTIONS);
private static final Key KEY_METHOD_ADDED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.METHOD_ADDED_TYPE_PARAMETER);
private static final Key KEY_METHOD_CHANGED_VARARGS_TO_ARRAY = getApiToolsKey(IApiProblemTypes.METHOD_CHANGED_VARARGS_TO_ARRAY);
private static final Key KEY_METHOD_CHANGED_DECREASE_ACCESS = getApiToolsKey(IApiProblemTypes.METHOD_CHANGED_DECREASE_ACCESS);
private static final Key KEY_METHOD_CHANGED_NON_ABSTRACT_TO_ABSTRACT = getApiToolsKey(IApiProblemTypes.METHOD_CHANGED_NON_ABSTRACT_TO_ABSTRACT);
private static final Key KEY_METHOD_CHANGED_NON_STATIC_TO_STATIC = getApiToolsKey(IApiProblemTypes.METHOD_CHANGED_NON_STATIC_TO_STATIC);
private static final Key KEY_METHOD_CHANGED_STATIC_TO_NON_STATIC = getApiToolsKey(IApiProblemTypes.METHOD_CHANGED_STATIC_TO_NON_STATIC);
private static final Key KEY_METHOD_CHANGED_NON_FINAL_TO_FINAL = getApiToolsKey(IApiProblemTypes.METHOD_CHANGED_NON_FINAL_TO_FINAL);
private static final Key KEY_METHOD_REMOVED_ANNOTATION_DEFAULT_VALUE = getApiToolsKey(IApiProblemTypes.METHOD_REMOVED_ANNOTATION_DEFAULT_VALUE);
private static final Key KEY_METHOD_REMOVED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.METHOD_REMOVED_TYPE_PARAMETER);
// constructor key constant
private static final Key KEY_CONSTRUCTOR_ADDED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.CONSTRUCTOR_ADDED_TYPE_PARAMETER);
private static final Key KEY_CONSTRUCTOR_CHANGED_VARARGS_TO_ARRAY = getApiToolsKey(IApiProblemTypes.CONSTRUCTOR_CHANGED_VARARGS_TO_ARRAY);
private static final Key KEY_CONSTRUCTOR_CHANGED_DECREASE_ACCESS = getApiToolsKey(IApiProblemTypes.CONSTRUCTOR_CHANGED_DECREASE_ACCESS);
private static final Key KEY_CONSTRUCTOR_REMOVED_TYPE_PARAMETER = getApiToolsKey(IApiProblemTypes.CONSTRUCTOR_REMOVED_TYPE_PARAMETER);
private static final Key KEY_TYPE_PARAMETER_ADDED_CLASS_BOUND = getApiToolsKey(IApiProblemTypes.TYPE_PARAMETER_ADDED_CLASS_BOUND);
private static final Key KEY_TYPE_PARAMETER_CHANGED_CLASS_BOUND = getApiToolsKey(IApiProblemTypes.TYPE_PARAMETER_CHANGED_CLASS_BOUND);
private static final Key KEY_TYPE_PARAMETER_REMOVED_CLASS_BOUND = getApiToolsKey(IApiProblemTypes.TYPE_PARAMETER_REMOVED_CLASS_BOUND);
private static final Key KEY_TYPE_PARAMETER_ADDED_INTERFACE_BOUND = getApiToolsKey(IApiProblemTypes.TYPE_PARAMETER_ADDED_INTERFACE_BOUND);
private static final Key KEY_TYPE_PARAMETER_CHANGED_INTERFACE_BOUND = getApiToolsKey(IApiProblemTypes.TYPE_PARAMETER_CHANGED_INTERFACE_BOUND);
private static final Key KEY_TYPE_PARAMETER_REMOVED_INTERFACE_BOUND = getApiToolsKey(IApiProblemTypes.TYPE_PARAMETER_REMOVED_INTERFACE_BOUND);
// version management keys
private static final Key KEY_MISSING_SINCE_TAG = getApiToolsKey(IApiProblemTypes.MISSING_SINCE_TAG);
private static final Key KEY_MALFORMED_SINCE_TAG = getApiToolsKey(IApiProblemTypes.MALFORMED_SINCE_TAG);
private static final Key KEY_INVALID_SINCE_TAG_VERSION = getApiToolsKey(IApiProblemTypes.INVALID_SINCE_TAG_VERSION);
private static final Key KEY_CHANGED_EXECUTION_ENV = getApiToolsKey(IApiProblemTypes.CHANGED_EXECUTION_ENV);
private static final Key KEY_INCOMPATIBLE_API_COMPONENT_VERSION = getApiToolsKey(IApiProblemTypes.INCOMPATIBLE_API_COMPONENT_VERSION);
private static final Key KEY_INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MINOR_WITHOUT_API_CHANGE = getApiToolsKey(
IApiProblemTypes.INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MINOR_WITHOUT_API_CHANGE);
private static final Key KEY_INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MAJOR_WITHOUT_BREAKING_CHANGE = getApiToolsKey(
IApiProblemTypes.INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MAJOR_WITHOUT_BREAKING_CHANGE);
private static final Key KEY_REPORT_API_BREAKAGE_WHEN_MAJOR_VERSION_INCREMENTED = getApiToolsKey(IApiProblemTypes.REPORT_API_BREAKAGE_WHEN_MAJOR_VERSION_INCREMENTED);
private static final Key KEY_REPORT_RESOLUTION_ERRORS_API_COMPONENT = getApiToolsKey(IApiProblemTypes.REPORT_RESOLUTION_ERRORS_API_COMPONENT);
// External Dependencies' Keys
private static final Key KEY_API_USE_SCAN_TYPE_PROBLEM = getApiToolsKey(IApiProblemTypes.API_USE_SCAN_TYPE_SEVERITY);
private static final Key KEY_API_USE_SCAN_METHOD_PROBLEM = getApiToolsKey(IApiProblemTypes.API_USE_SCAN_METHOD_SEVERITY);
private static final Key KEY_API_USE_SCAN_FIELD_PROBLEM = getApiToolsKey(IApiProblemTypes.API_USE_SCAN_FIELD_SEVERITY);
/**
* @since 1.1
*/
private static final Key KEY_AUTOMATICALLY_REMOVE_PROBLEM_FILTERS = getApiToolsKey(IApiProblemTypes.AUTOMATICALLY_REMOVE_UNUSED_PROBLEM_FILTERS);
public static final int API_SCANNING_USAGE_PAGE_ID = 0;
public static final int COMPATIBILITY_PAGE_ID = 1;
public static final int VERSION_MANAGEMENT_PAGE_ID = 2;
public static final int API_COMPONENT_RESOLUTION_PAGE_ID = 3;
public static final int API_USE_SCANS_PAGE_ID = 4;
static Key[] fgAllApiComponentResolutionKeys = {
KEY_REPORT_RESOLUTION_ERRORS_API_COMPONENT,
KEY_UNUSED_PROBLEM_FILTERS,
KEY_AUTOMATICALLY_REMOVE_PROBLEM_FILTERS };
static Key[] fgAllCompatibilityKeys = {
KEY_API_COMPONENT_REMOVED_API_TYPE, KEY_API_COMPONENT_REMOVED_TYPE,
KEY_API_COMPONENT_REMOVED_REEXPORTED_API_TYPE,
KEY_API_COMPONENT_REMOVED_REEXPORTED_TYPE,
KEY_ANNOTATION_ADDED_FIELD,
KEY_ANNOTATION_REMOVED_FIELD, KEY_ANNOTATION_REMOVED_METHOD,
KEY_ANNOTATION_REMOVED_TYPE_MEMBER,
KEY_ANNOTATION_CHANGED_TYPE_CONVERSION,
KEY_ANNOTATION_ADDED_METHOD_NO_DEFAULT_VALUE,
KEY_INTERFACE_ADDED_FIELD, KEY_INTERFACE_ADDED_METHOD,
KEY_INTERFACE_ADDED_DEFAULT_METHOD,
KEY_INTERFACE_ADDED_RESTRICTIONS,
KEY_INTERFACE_ADDED_SUPER_INTERFACE_WITH_METHODS,
KEY_INTERFACE_ADDED_TYPE_PARAMETER,
KEY_INTERFACE_REMOVED_TYPE_PARAMETER, KEY_INTERFACE_REMOVED_FIELD,
KEY_INTERFACE_REMOVED_METHOD, KEY_INTERFACE_REMOVED_TYPE_MEMBER,
KEY_INTERFACE_CHANGED_TYPE_CONVERSION,
KEY_INTERFACE_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_ENUM_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_ENUM_CHANGED_TYPE_CONVERSION, KEY_ENUM_REMOVED_FIELD,
KEY_ENUM_REMOVED_ENUM_CONSTANT, KEY_ENUM_REMOVED_METHOD,
KEY_ENUM_REMOVED_TYPE_MEMBER, KEY_CLASS_ADDED_FIELD, KEY_CLASS_ADDED_METHOD,
KEY_CLASS_ADDED_RESTRICTIONS, KEY_CLASS_ADDED_TYPE_PARAMETER,
KEY_CLASS_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_CLASS_CHANGED_NON_ABSTRACT_TO_ABSTRACT,
KEY_CLASS_CHANGED_NON_FINAL_TO_FINAL,
KEY_CLASS_CHANGED_TYPE_CONVERSION,
KEY_CLASS_CHANGED_DECREASE_ACCESS, KEY_CLASS_REMOVED_FIELD,
KEY_CLASS_REMOVED_METHOD, KEY_CLASS_REMOVED_CONSTRUCTOR,
KEY_CLASS_REMOVED_SUPERCLASS, KEY_CLASS_REMOVED_TYPE_MEMBER,
KEY_CLASS_REMOVED_TYPE_PARAMETER, KEY_FIELD_ADDED_VALUE,
KEY_FIELD_CHANGED_TYPE, KEY_FIELD_CHANGED_VALUE,
KEY_FIELD_CHANGED_DECREASE_ACCESS,
KEY_FIELD_CHANGED_FINAL_TO_NON_FINAL_STATIC_CONSTANT,
KEY_FIELD_CHANGED_NON_FINAL_TO_FINAL,
KEY_FIELD_CHANGED_STATIC_TO_NON_STATIC,
KEY_FIELD_CHANGED_NON_STATIC_TO_STATIC, KEY_FIELD_REMOVED_VALUE,
KEY_FIELD_REMOVED_TYPE_ARGUMENT, KEY_METHOD_ADDED_RESTRICTIONS,
KEY_METHOD_ADDED_TYPE_PARAMETER,
KEY_METHOD_CHANGED_VARARGS_TO_ARRAY,
KEY_METHOD_CHANGED_DECREASE_ACCESS,
KEY_METHOD_CHANGED_NON_ABSTRACT_TO_ABSTRACT,
KEY_METHOD_CHANGED_NON_STATIC_TO_STATIC,
KEY_METHOD_CHANGED_STATIC_TO_NON_STATIC,
KEY_METHOD_CHANGED_NON_FINAL_TO_FINAL,
KEY_METHOD_REMOVED_ANNOTATION_DEFAULT_VALUE,
KEY_METHOD_REMOVED_TYPE_PARAMETER,
KEY_CONSTRUCTOR_ADDED_TYPE_PARAMETER,
KEY_CONSTRUCTOR_CHANGED_VARARGS_TO_ARRAY,
KEY_CONSTRUCTOR_CHANGED_DECREASE_ACCESS,
KEY_CONSTRUCTOR_REMOVED_TYPE_PARAMETER,
KEY_TYPE_PARAMETER_ADDED_CLASS_BOUND,
KEY_TYPE_PARAMETER_ADDED_INTERFACE_BOUND,
KEY_TYPE_PARAMETER_CHANGED_CLASS_BOUND,
KEY_TYPE_PARAMETER_CHANGED_INTERFACE_BOUND,
KEY_TYPE_PARAMETER_REMOVED_CLASS_BOUND,
KEY_TYPE_PARAMETER_REMOVED_INTERFACE_BOUND, };
static Key[] fgAllApiScanningKeys = {
KEY_NOIMPLEMENT, KEY_NOEXTEND, KEY_NOREFERENCE, KEY_NOINSTANTIATE,
KEY_NOOVERRIDE, KEY_LEAK_EXTEND, KEY_LEAK_FIELD_DECL,
KEY_LEAK_IMPLEMENT, KEY_LEAK_METHOD_PARAM,
KEY_LEAK_METHOD_RETURN_TYPE, KEY_INVALID_JAVADOC_TAG,
KEY_INVALID_ANNOTATION, KEY_INVALID_REFERENCE_IN_SYSTEM_LIBRARIES,
};
static Key[] fgAllVersionManagementKeys = {
KEY_MISSING_SINCE_TAG, KEY_MALFORMED_SINCE_TAG,
KEY_INVALID_SINCE_TAG_VERSION,
KEY_INCOMPATIBLE_API_COMPONENT_VERSION,
KEY_INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MINOR_WITHOUT_API_CHANGE,
KEY_INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MAJOR_WITHOUT_BREAKING_CHANGE, KEY_CHANGED_EXECUTION_ENV };
static Key[] fgAllExternalDependenciesKeys = {
KEY_API_USE_SCAN_TYPE_PROBLEM, KEY_API_USE_SCAN_METHOD_PROBLEM,
KEY_API_USE_SCAN_FIELD_PROBLEM };
/**
* An array of all of the keys for the page
*/
private static Key[] fgAllKeys = {
KEY_NOIMPLEMENT,
KEY_NOEXTEND,
KEY_NOINSTANTIATE,
KEY_NOREFERENCE,
KEY_NOOVERRIDE,
KEY_LEAK_EXTEND,
KEY_LEAK_FIELD_DECL,
KEY_LEAK_IMPLEMENT,
KEY_LEAK_METHOD_PARAM,
KEY_LEAK_METHOD_RETURN_TYPE,
KEY_INVALID_JAVADOC_TAG,
KEY_INVALID_ANNOTATION,
KEY_INVALID_REFERENCE_IN_SYSTEM_LIBRARIES,
KEY_UNUSED_PROBLEM_FILTERS,
KEY_API_COMPONENT_REMOVED_API_TYPE,
KEY_API_COMPONENT_REMOVED_TYPE,
KEY_API_COMPONENT_REMOVED_REEXPORTED_API_TYPE,
KEY_API_COMPONENT_REMOVED_REEXPORTED_TYPE,
KEY_ANNOTATION_ADDED_FIELD,
KEY_ANNOTATION_REMOVED_FIELD,
KEY_ANNOTATION_REMOVED_METHOD,
KEY_ANNOTATION_REMOVED_TYPE_MEMBER,
KEY_ANNOTATION_CHANGED_TYPE_CONVERSION,
KEY_ANNOTATION_ADDED_METHOD_NO_DEFAULT_VALUE,
KEY_INTERFACE_ADDED_FIELD,
KEY_INTERFACE_ADDED_METHOD,
KEY_INTERFACE_ADDED_DEFAULT_METHOD,
KEY_INTERFACE_ADDED_RESTRICTIONS,
KEY_INTERFACE_ADDED_SUPER_INTERFACE_WITH_METHODS,
KEY_INTERFACE_ADDED_TYPE_PARAMETER,
KEY_INTERFACE_REMOVED_TYPE_PARAMETER,
KEY_INTERFACE_REMOVED_FIELD,
KEY_INTERFACE_REMOVED_METHOD,
KEY_INTERFACE_REMOVED_TYPE_MEMBER,
KEY_INTERFACE_CHANGED_TYPE_CONVERSION,
KEY_INTERFACE_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_ENUM_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_ENUM_CHANGED_TYPE_CONVERSION,
KEY_ENUM_REMOVED_FIELD,
KEY_ENUM_REMOVED_ENUM_CONSTANT,
KEY_ENUM_REMOVED_METHOD,
KEY_ENUM_REMOVED_TYPE_MEMBER,
KEY_CLASS_ADDED_FIELD,
KEY_CLASS_ADDED_METHOD,
KEY_CLASS_ADDED_RESTRICTIONS,
KEY_CLASS_ADDED_TYPE_PARAMETER,
KEY_CLASS_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_CLASS_CHANGED_NON_ABSTRACT_TO_ABSTRACT,
KEY_CLASS_CHANGED_NON_FINAL_TO_FINAL,
KEY_CLASS_CHANGED_TYPE_CONVERSION,
KEY_CLASS_CHANGED_DECREASE_ACCESS,
KEY_CLASS_REMOVED_FIELD,
KEY_CLASS_REMOVED_METHOD,
KEY_CLASS_REMOVED_CONSTRUCTOR,
KEY_CLASS_REMOVED_SUPERCLASS,
KEY_CLASS_REMOVED_TYPE_MEMBER,
KEY_CLASS_REMOVED_TYPE_PARAMETER,
KEY_FIELD_ADDED_VALUE,
KEY_FIELD_CHANGED_TYPE,
KEY_FIELD_CHANGED_VALUE,
KEY_FIELD_CHANGED_DECREASE_ACCESS,
KEY_FIELD_CHANGED_FINAL_TO_NON_FINAL_STATIC_CONSTANT,
KEY_FIELD_CHANGED_NON_FINAL_TO_FINAL,
KEY_FIELD_CHANGED_STATIC_TO_NON_STATIC,
KEY_FIELD_CHANGED_NON_STATIC_TO_STATIC,
KEY_FIELD_REMOVED_VALUE,
KEY_FIELD_REMOVED_TYPE_ARGUMENT,
KEY_METHOD_ADDED_RESTRICTIONS,
KEY_METHOD_ADDED_TYPE_PARAMETER,
KEY_METHOD_CHANGED_VARARGS_TO_ARRAY,
KEY_METHOD_CHANGED_DECREASE_ACCESS,
KEY_METHOD_CHANGED_NON_ABSTRACT_TO_ABSTRACT,
KEY_METHOD_CHANGED_NON_STATIC_TO_STATIC,
KEY_METHOD_CHANGED_STATIC_TO_NON_STATIC,
KEY_METHOD_CHANGED_NON_FINAL_TO_FINAL,
KEY_METHOD_REMOVED_ANNOTATION_DEFAULT_VALUE,
KEY_METHOD_REMOVED_TYPE_PARAMETER,
KEY_CONSTRUCTOR_ADDED_TYPE_PARAMETER,
KEY_CONSTRUCTOR_CHANGED_VARARGS_TO_ARRAY,
KEY_CONSTRUCTOR_CHANGED_DECREASE_ACCESS,
KEY_CONSTRUCTOR_REMOVED_TYPE_PARAMETER,
KEY_TYPE_PARAMETER_ADDED_CLASS_BOUND,
KEY_TYPE_PARAMETER_ADDED_INTERFACE_BOUND,
KEY_TYPE_PARAMETER_CHANGED_CLASS_BOUND,
KEY_TYPE_PARAMETER_CHANGED_INTERFACE_BOUND,
KEY_TYPE_PARAMETER_REMOVED_CLASS_BOUND,
KEY_TYPE_PARAMETER_REMOVED_INTERFACE_BOUND,
KEY_MISSING_SINCE_TAG,
KEY_MALFORMED_SINCE_TAG,
KEY_INVALID_SINCE_TAG_VERSION,
KEY_CHANGED_EXECUTION_ENV,
KEY_INCOMPATIBLE_API_COMPONENT_VERSION,
KEY_INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MINOR_WITHOUT_API_CHANGE,
KEY_INCOMPATIBLE_API_COMPONENT_VERSION_REPORT_MAJOR_WITHOUT_BREAKING_CHANGE,
KEY_REPORT_API_BREAKAGE_WHEN_MAJOR_VERSION_INCREMENTED,
KEY_REPORT_RESOLUTION_ERRORS_API_COMPONENT,
KEY_AUTOMATICALLY_REMOVE_PROBLEM_FILTERS,
KEY_API_USE_SCAN_TYPE_PROBLEM, KEY_API_USE_SCAN_METHOD_PROBLEM,
KEY_API_USE_SCAN_FIELD_PROBLEM };
/**
* Constant representing the {@link IDialogSettings} section for this block
*/
private static final String SETTINGS = "api_errorswarnings_block"; //$NON-NLS-1$
/**
* Constant representing the severity values presented in the combo boxes
* for each option
*/
private static final String[] SEVERITIES_LABELS = {
PreferenceMessages.ApiErrorsWarningsConfigurationBlock_error,
PreferenceMessages.ApiErrorsWarningsConfigurationBlock_warning,
PreferenceMessages.ApiErrorsWarningsConfigurationBlock_ignore };
/**
* Constant representing the severity values presented in the combo boxes
* for each option
*/
private static final String[] SEVERITIES = {
ApiPlugin.VALUE_ERROR, ApiPlugin.VALUE_WARNING,
ApiPlugin.VALUE_IGNORE, };
/**
* Default value set for check box controls
*
* @since 1.1
*/
private static final String[] CHECKBOX_VALUES = {
ApiPlugin.VALUE_ENABLED, ApiPlugin.VALUE_DISABLED };
/**
* Default selection listener for controls on the page
*/
private final SelectionListener selectionlistener = new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent e) {
Widget widget = e.widget;
ControlData data = (ControlData) widget.getData();
Key key = data.getKey();
String newValue = null;
if (widget instanceof Button button) {
newValue = data.getValue(button.getSelection());
} else if (widget instanceof Combo combo) {
newValue = data.getValue(combo.getSelectionIndex());
} else {
return;
}
setValue(key, newValue);
validateSettings(key);
}
};
public void validateSettings(Key changedKey) {
// we need to disable the two checkboxes if the key is for the bundle
// version
if (changedKey != null) {
if (KEY_INCOMPATIBLE_API_COMPONENT_VERSION.equals(changedKey) || KEY_INVALID_REFERENCE_IN_SYSTEM_LIBRARIES.equals(changedKey)) {
updateEnableStates();
}
} else {
updateEnableStates();
}
}
protected boolean checkValue(Key key, String value) {
return value.equals(getValue(key));
}
protected String getValue(Key key) {
if (fOldProjectSettings != null) {
return fOldProjectSettings.get(key);
}
return key.getStoredValue(fLookupOrder, false, fManager);
}
protected String setValue(Key key, String value) {
fDirty = true;
fRebuildcount = 0;
if (fOldProjectSettings != null) {
return fOldProjectSettings.put(key, value);
}
String oldValue = getValue(key);
key.setStoredValue(fLookupOrder[0], value, fManager);
return oldValue;
}
private void updateEnableStates() {
boolean enableSystemLibraryCheck = !checkValue(KEY_INVALID_REFERENCE_IN_SYSTEM_LIBRARIES,
ApiPlugin.VALUE_IGNORE);
if (this.fSystemLibraryControls != null) {
for (Control control : fSystemLibraryControls) {
control.setEnabled(enableSystemLibraryCheck);
}
}
}
class SetAllSelectionAdapter extends SelectionAdapter {
String newValue;
int kind;
public SetAllSelectionAdapter(int kind, String newValue) {
this.kind = kind;
this.newValue = newValue;
}
@Override
public void widgetSelected(SelectionEvent e) {
switch (this.kind) {
case API_SCANNING_USAGE_PAGE_ID:
setAllTo(this.newValue, fgAllApiScanningKeys);
break;
case VERSION_MANAGEMENT_PAGE_ID:
setAllTo(this.newValue, fgAllVersionManagementKeys);
break;
case COMPATIBILITY_PAGE_ID:
setAllTo(this.newValue, fgAllCompatibilityKeys);
break;
case API_COMPONENT_RESOLUTION_PAGE_ID:
setAllTo(this.newValue, fgAllApiComponentResolutionKeys);
break;
case API_USE_SCANS_PAGE_ID:
setAllTo(this.newValue, fgAllExternalDependenciesKeys);
break;
default:
break;
}
}
}
/**
* Listing of all of the {@link ExpandableComposite}s in the block
*/
private final List<ExpandableComposite> fExpComps = new ArrayList<>();
/**
* Listing of all of the {@link Combo}s added to the block
*/
private final List<Combo> fCombos = new ArrayList<>();
/**
* Map of combo and label
*/
private final Map<Combo, Label> fComboLabelMap = new HashMap<>();
/**
* Listing of all of the {@link Button} with SWT.check added to the block
*/
private final List<Button> fCheckBoxes = new ArrayList<>();
/**
* Control used inside the system library ee group
*/
private List<Control> fSystemLibraryControls = null;
/**
* The context of settings locations to search for values in
*/
private IScopeContext[] fLookupOrder = null;
/**
* The project this block is working on settings for. Only applies in the
* case of project specific settings
*/
private IProject fProject = null;
/**
* the working copy manager to work with settings
*/
private IWorkingCopyManager fManager = null;
/**
* The main composite for the configuration block, used for
* enabling/disabling the block
*/
private Composite fMainComp = null;
/**
* Stored old fProject specific settings.
*/
private IdentityHashMap<Key, String> fOldProjectSettings = null;
/**
* Flag used to know if the page needs saving or not
*/
private boolean fDirty = false;
/**
* counter to know how many times we have prompted users' to rebuild
*/
private int fRebuildcount = 0;
/**
* The parent this block has been added to
*/
private Composite fParent = null;
/**
* The tab folder for the various tabs
*/
private TabFolder fTabFolder = null;
/**
* Constructor
*/
public ApiErrorsWarningsConfigurationBlock(IProject project, IWorkbenchPreferenceContainer container) {
fProject = project;
if (fProject != null) {
fLookupOrder = new IScopeContext[] {
new ProjectScope(fProject), InstanceScope.INSTANCE,
DefaultScope.INSTANCE };
} else {
fLookupOrder = new IScopeContext[] {
InstanceScope.INSTANCE, DefaultScope.INSTANCE };
}
if (container == null) {
fManager = new WorkingCopyManager();
} else {
fManager = container.getWorkingCopyManager();
}
if (fProject == null || hasProjectSpecificSettings(fProject)) {
fOldProjectSettings = null;
} else {
fOldProjectSettings = new IdentityHashMap<>();
for (Key key : fgAllKeys) {
fOldProjectSettings.put(key, key.getStoredValue(fLookupOrder, false, fManager));
}
}
}
/**
* Creates the control in the parent control
*
* @param parent the parent control
*/
public Control createControl(Composite parent) {
fParent = parent;
SWTFactory.createVerticalSpacer(parent, 1);
fMainComp = SWTFactory.createComposite(parent, 1, 1, GridData.FILL_BOTH);
fTabFolder = new TabFolder(fMainComp, SWT.NONE);
GridData gd = new GridData(GridData.FILL_BOTH);
gd.heightHint = 400;
fTabFolder.setLayoutData(gd);
// API scanning usage options
createPage(API_SCANNING_USAGE_PAGE_ID, fTabFolder, PreferenceMessages.ApiToolingNotificationsBlock_0, PreferenceMessages.ApiProblemSeveritiesConfigurationBlock_3);
// API compatibility options
createPage(COMPATIBILITY_PAGE_ID, fTabFolder, PreferenceMessages.ApiToolingNotificationsBlock_1, PreferenceMessages.ApiProblemSeveritiesConfigurationBlock_8);
createPage(VERSION_MANAGEMENT_PAGE_ID, fTabFolder, PreferenceMessages.ApiToolingNotificationsBlock_2, PreferenceMessages.ApiProblemSeveritiesConfigurationBlock_9);
createPage(API_COMPONENT_RESOLUTION_PAGE_ID, fTabFolder, PreferenceMessages.ApiToolingNotificationsBlock_3, PreferenceMessages.ApiProblemSeveritiesConfigurationBlock_10);
createPage(API_USE_SCANS_PAGE_ID, fTabFolder, PreferenceMessages.ApiToolingNotificationsBlock_4, PreferenceMessages.ApiProblemSeveritiesConfigurationBlock_11);
restoreExpansionState();
validateSettings(null);
Dialog.applyDialogFont(fMainComp);
return fMainComp;
}
private void initializeComboControls(Composite composite, String[] labels, Key[] keys) {
for (int i = 0, max = labels.length; i < max; i++) {
createComboControl(composite, labels[i], keys[i]);
}
}
public int convertWidthInCharsToPixels(Font font, int chars) {
GC gc = new GC(font.getDevice());
gc.setFont(font);
FontMetrics fontMetrics = gc.getFontMetrics();
gc.dispose();
return Dialog.convertWidthInCharsToPixels(fontMetrics, chars);
}
protected Button addCheckBox(Composite parent, String label, Key key, String[] values, int indent) {
ControlData data = new ControlData(key, values);
Font dialogFont = JFaceResources.getDialogFont();
GridData gd = new GridData(GridData.HORIZONTAL_ALIGN_FILL);
gd.horizontalSpan = 3;
gd.horizontalIndent = convertWidthInCharsToPixels(dialogFont, indent);
Button checkBox = new Button(parent, SWT.CHECK);
checkBox.setFont(dialogFont);
checkBox.setText(label);
checkBox.setData(data);
checkBox.setLayoutData(gd);
checkBox.addSelectionListener(this.selectionlistener);
String currValue = null;
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=280619
// only look up the project and default scopes if the project
// already contains project-specific settings
if (hasProjectSpecificSettings(fProject)) {
currValue = key.getStoredValue(new IScopeContext[] {
new ProjectScope(fProject), DefaultScope.INSTANCE }, false, fManager);
} else {
currValue = key.getStoredValue(fLookupOrder, false, fManager);
}
checkBox.setSelection(data.getSelection(currValue) == 0);
fCheckBoxes.add(checkBox);
return checkBox;
}
/**
* Creates a tab page parented in the folder
*/
private Composite createPage(int tabID, TabFolder folder, String name, String description) {
Composite page = SWTFactory.createComposite(folder, 1, 1, GridData.FILL_BOTH);
TabItem tab = new TabItem(folder, SWT.NONE, tabID);
tab.setText(name);
tab.setControl(page);
SWTFactory.createVerticalSpacer(page, 1);
// Add 'Achieving API Binary Compatibility' link at the top for compatibility tab
if (tabID == COMPATIBILITY_PAGE_ID) {
Link link = new Link(page, SWT.CENTER);
link.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, false, false, 1, 7));
String linkHttp = "<a href=\"https://wiki.eclipse.org/Evolving_Java-based_APIs_2\">" //$NON-NLS-1$
+ PreferenceMessages.ApiErrorsWarningsConfigurationBlock_4 + "</a>"; //$NON-NLS-1$
link.setText(NLS.bind(PreferenceMessages.ApiErrorsWarningsConfigurationBlock_5, linkHttp));
link.setSize(400, 100);
link.addSelectionListener(SelectionListener.widgetSelectedAdapter(e -> {
try {
PlatformUI.getWorkbench().getBrowserSupport().getExternalBrowser().openURL(new URL(e.text));
} catch (Exception ex) {
}
}));
}
SWTFactory.createWrapLabel(page, description, 1);
SWTFactory.createVerticalSpacer(page, 1);
switch (tabID) {
case API_SCANNING_USAGE_PAGE_ID: {
createApiScanningPage(page);
break;
}
case VERSION_MANAGEMENT_PAGE_ID: {
createVersionManagementPage(page);
break;
}
case API_COMPONENT_RESOLUTION_PAGE_ID: {
createApiComponentResolutionPage(page);
break;
}
case COMPATIBILITY_PAGE_ID: {
createCompatibilityPage(page);
break;
}
case API_USE_SCANS_PAGE_ID: {
createAPIUseScanPage(page);
break;
}
default:
break;
}
SWTFactory.createVerticalSpacer(page, 1);
Group bcomp = SWTFactory.createGroup(page, PreferenceMessages.ApiErrorsWarningsConfigurationBlock_setAllto, 3, 2, GridData.FILL_HORIZONTAL);
Button button = SWTFactory.createPushButton(bcomp, PreferenceMessages.ApiErrorsWarningsConfigurationBlock_error_button, null, SWT.RIGHT);
button.addSelectionListener(new SetAllSelectionAdapter(tabID, ApiPlugin.VALUE_ERROR));
button = SWTFactory.createPushButton(bcomp, PreferenceMessages.ApiErrorsWarningsConfigurationBlock_warning_button, null, SWT.RIGHT);
button.addSelectionListener(new SetAllSelectionAdapter(tabID, ApiPlugin.VALUE_WARNING));
button = SWTFactory.createPushButton(bcomp, PreferenceMessages.ApiErrorsWarningsConfigurationBlock_ignore_button, null, SWT.RIGHT);
button.addSelectionListener(new SetAllSelectionAdapter(tabID, ApiPlugin.VALUE_IGNORE));
return page;
}
private void createAPIUseScanPage(Composite page) {
Composite vcomp = SWTFactory.createComposite(page, 2, 1, GridData.FILL_BOTH);
initializeComboControls(vcomp, new String[] {
PreferenceMessages.ApiUseScanConfigurationBlock_unresolvedTypeProblem,
PreferenceMessages.ApiUseScanConfigurationBlock_unresolvedMethodProblem,
PreferenceMessages.ApiUseScanConfigurationBlock_unresolvedFieldProblem }, new Key[] {
KEY_API_USE_SCAN_TYPE_PROBLEM, KEY_API_USE_SCAN_METHOD_PROBLEM,
KEY_API_USE_SCAN_FIELD_PROBLEM });
}
private void createCompatibilityPage(Composite page) {
// compatibility
Composite vcomp = SWTFactory.createComposite(page, 2, 1, GridData.FILL_HORIZONTAL);
addCheckBox(vcomp, PreferenceMessages.CompatibilityReportApiBreakageWhenMajorVersionIncremented, KEY_REPORT_API_BREAKAGE_WHEN_MAJOR_VERSION_INCREMENTED, CHECKBOX_VALUES, 2);
ScrolledComposite scomp = new ScrolledComposite(page, SWT.H_SCROLL | SWT.V_SCROLL);
scomp.setExpandHorizontal(true);
scomp.setExpandVertical(true);
scomp.setLayout(new GridLayout(1, false));
scomp.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true));
scomp.addListener(SWT.Resize, event -> handleExpand(getScrollingParent(event.widget)));
Composite sbody = SWTFactory.createComposite(scomp, 1, 1, GridData.FILL_BOTH);
scomp.setContent(sbody);
Composite client = createExpansibleComposite(sbody, PreferenceMessages.CompatibilityAPIComponentElement);
initializeComboControls(client, new String[] {
PreferenceMessages.API_COMPONENT_REMOVED_API_TYPE,
PreferenceMessages.API_COMPONENT_REMOVED_TYPE,
PreferenceMessages.API_COMPONENT_REMOVED_REEXPORTED_API_TYPE,
PreferenceMessages.API_COMPONENT_REMOVED_REEXPORTED_TYPE, }, new Key[] {
KEY_API_COMPONENT_REMOVED_API_TYPE,
KEY_API_COMPONENT_REMOVED_TYPE,
KEY_API_COMPONENT_REMOVED_REEXPORTED_API_TYPE,
KEY_API_COMPONENT_REMOVED_REEXPORTED_TYPE, });
client = createExpansibleComposite(sbody, PreferenceMessages.CompatibilityClassElement);
initializeComboControls(client, new String[] {
PreferenceMessages.CLASS_ADDED_FIELD,
PreferenceMessages.CLASS_ADDED_METHOD,
PreferenceMessages.CLASS_ADDED_RESTRICTIONS,
PreferenceMessages.CLASS_ADDED_TYPE_PARAMETER,
PreferenceMessages.CLASS_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
PreferenceMessages.CLASS_CHANGED_NON_ABSTRACT_TO_ABSTRACT,
PreferenceMessages.CLASS_CHANGED_NON_FINAL_TO_FINAL,
PreferenceMessages.CLASS_CHANGED_TYPE_CONVERSION,
PreferenceMessages.CLASS_CHANGED_DECREASE_ACCESS,
PreferenceMessages.CLASS_REMOVED_FIELD,
PreferenceMessages.CLASS_REMOVED_METHOD,
PreferenceMessages.CLASS_REMOVED_CONSTRUCTOR,
PreferenceMessages.CLASS_REMOVED_SUPERCLASS,
PreferenceMessages.CLASS_REMOVED_TYPE_MEMBER,
PreferenceMessages.CLASS_REMOVED_TYPE_PARAMETER, },
new Key[] { KEY_CLASS_ADDED_FIELD,
KEY_CLASS_ADDED_METHOD, KEY_CLASS_ADDED_RESTRICTIONS,
KEY_CLASS_ADDED_TYPE_PARAMETER,
KEY_CLASS_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_CLASS_CHANGED_NON_ABSTRACT_TO_ABSTRACT,
KEY_CLASS_CHANGED_NON_FINAL_TO_FINAL,
KEY_CLASS_CHANGED_TYPE_CONVERSION,
KEY_CLASS_CHANGED_DECREASE_ACCESS, KEY_CLASS_REMOVED_FIELD,
KEY_CLASS_REMOVED_METHOD, KEY_CLASS_REMOVED_CONSTRUCTOR,
KEY_CLASS_REMOVED_SUPERCLASS, KEY_CLASS_REMOVED_TYPE_MEMBER,
KEY_CLASS_REMOVED_TYPE_PARAMETER, });
client = createExpansibleComposite(sbody, PreferenceMessages.CompatibilityInterfaceElement);
initializeComboControls(client, new String[] {
PreferenceMessages.INTERFACE_ADDED_FIELD,
PreferenceMessages.INTERFACE_ADDED_METHOD,
PreferenceMessages.INTERFACE_ADDED_DEFAULT_METHOD,
PreferenceMessages.INTERFACE_ADDED_RESTRICTIONS,
PreferenceMessages.INTERFACE_ADDED_SUPER_INTERFACE_WITH_METHODS,
PreferenceMessages.INTERFACE_ADDED_TYPE_PARAMETER,
PreferenceMessages.INTERFACE_CHANGED_TYPE_CONVERSION,
PreferenceMessages.INTERFACE_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
PreferenceMessages.INTERFACE_REMOVED_TYPE_PARAMETER,
PreferenceMessages.INTERFACE_REMOVED_FIELD,
PreferenceMessages.INTERFACE_REMOVED_METHOD,
PreferenceMessages.INTERFACE_REMOVED_TYPE_MEMBER, }, new Key[] {
KEY_INTERFACE_ADDED_FIELD, KEY_INTERFACE_ADDED_METHOD,
KEY_INTERFACE_ADDED_DEFAULT_METHOD,
KEY_INTERFACE_ADDED_RESTRICTIONS,
KEY_INTERFACE_ADDED_SUPER_INTERFACE_WITH_METHODS,
KEY_INTERFACE_ADDED_TYPE_PARAMETER,
KEY_INTERFACE_CHANGED_TYPE_CONVERSION,
KEY_INTERFACE_CHANGED_CONTRACTED_SUPERINTERFACES_SET,
KEY_INTERFACE_REMOVED_TYPE_PARAMETER,
KEY_INTERFACE_REMOVED_FIELD, KEY_INTERFACE_REMOVED_METHOD,
KEY_INTERFACE_REMOVED_TYPE_MEMBER, });
client = createExpansibleComposite(sbody, PreferenceMessages.CompatibilityEnumElement);