-
Notifications
You must be signed in to change notification settings - Fork 921
Expand file tree
/
Copy patharch.xml
More file actions
1282 lines (1104 loc) · 42.8 KB
/
arch.xml
File metadata and controls
1282 lines (1104 loc) · 42.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE api-answers PUBLIC "-//NetBeans//DTD Arch Answers//EN" "../../nbbuild/antsrc/org/netbeans/nbbuild/Arch.dtd" [
<!ENTITY api-questions SYSTEM "../../nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">
]>
<api-answers
question-version="1.28"
module="Java Navigation"
author="tzezula@netbeans.org"
>
&api-questions;
<!--
<question id="arch-overall" when="init">
Describe the overall architecture.
<hint>
What will be API for
<a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi">
clients and what support API</a>?
What parts will be pluggable?
How will plug-ins be registered? Please use <code><api type="export"/></code>
to describe your general APIs and specify their
<a href="http://openide.netbeans.org/tutorial/api-design.html#category-private">
stability categories</a>.
If possible please provide simple diagrams.
</hint>
</question>
-->
<answer id="arch-overall">
<ol>
<li>
<api group="layer" name="Navigator-Actions-Members" type="export" category="stable">
Provides an extension point for registering actions added into nodes in java navigator.
</api>
</li>
<li>
<api group="layer" name="Navigator-Actions-Hierarchy" type="export" category="stable">
Provides an extension point for registering actions added into nodes in java hierarchy view.
</api>
</li>
</ol>
</answer>
<!--
<question id="arch-quality" when="init">
How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">quality</a>
of your code be tested and
how are future regressions going to be prevented?
<hint>
What kind of testing do
you want to use? How much functionality, in which areas,
should be covered by the tests? How you find out that your
project was successful?
</hint>
</question>
-->
<answer id="arch-quality">
<p>
The SPI is covered by unit tests.
</p>
</answer>
<!--
<question id="arch-time" when="init">
What are the time estimates of the work?
<hint>
Please express your estimates of how long the design, implementation,
stabilization are likely to last. How many people will be needed to
implement this and what is the expected milestone by which the work should be
ready?
</hint>
</question>
-->
<answer id="arch-time">
<p>
Stable extension points.
</p>
</answer>
<!--
<question id="arch-usecases" when="init">
<hint>
Content of this answer will be displayed as part of page at
http://www.netbeans.org/download/dev/javadoc/usecases.html
You can use tags <usecase name="name> regular html description </usecase>
and if you want to use an URL you can prefix if with @TOP@ to begin
at the root of your javadoc
</hint>
Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase">
use cases</a> of the new API. Who will use it under
what circumstances? What kind of code would typically need to be written
to use the module?
</question>
-->
<answer id="arch-usecases">
<p>
Allow to 3rd party modules add additional actions to hierarchy or navigator view.
</p>
</answer>
<!--
<question id="arch-what" when="init">
What is this project good for?
<hint>
Please provide here a few lines describing the project,
what problem it should solve, provide links to documentation,
specifications, etc.
</hint>
</question>
-->
<answer id="arch-what">
<p>
Provides java navigation features.
</p>
</answer>
<!--
<question id="arch-where" when="impl">
Where one can find sources for your module?
<hint>
Please provide link to the CVS web client at
http://www.netbeans.org/download/source_browse.html
or just use tag defaultanswer generate='here'
</hint>
</question>
-->
<answer id="arch-where">
<defaultanswer generate='here' />
</answer>
<!--
<question id="compat-deprecation" when="init">
How the introduction of your project influences functionality
provided by previous version of the product?
<hint>
If you are planning to deprecate/remove/change any existing APIs,
list them here accompanied with the reason explaining why you
are doing so.
</hint>
</question>
-->
<answer id="compat-deprecation">
<p>
No influence.
</p>
</answer>
<!--
<question id="compat-i18n" when="impl">
Is your module correctly internationalized?
<hint>
Correct internationalization means that it obeys instructions
at <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/i18n-branding.html">
NetBeans I18N pages</a>.
</hint>
</question>
-->
<answer id="compat-i18n">
<p>
The module is I18N correct.
</p>
</answer>
<!--
<question id="compat-standards" when="init">
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</question>
-->
<answer id="compat-standards">
<p>
No.
</p>
</answer>
<!--
<question id="compat-version" when="impl">
Can your module coexist with earlier and future
versions of itself? Can you correctly read all old settings? Will future
versions be able to read your current settings? Can you read
or politely ignore settings stored by a future version?
<hint>
Very helpful for reading settings is to store version number
there, so future versions can decide whether how to read/convert
the settings and older versions can ignore the new ones.
</hint>
</question>
-->
<answer id="compat-version">
<p>
The module uses <code>NbPreferences</code> to store settings and can
possibly read older version of settings.
</p>
</answer>
<!--
<question id="dep-jre" when="final">
Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
<hint>
It is expected that if your module runs on 1.x that it will run
on 1.x+1 if no, state that please. Also describe here cases where
you run different code on different versions of JRE and why.
</hint>
</question>
-->
<answer id="dep-jre">
<p>
1.6+
</p>
</answer>
<!--
<question id="dep-jrejdk" when="final">
Do you require the JDK or is the JRE enough?
</question>
-->
<answer id="dep-jrejdk">
<p>
JRE
</p>
</answer>
<!--
<question id="dep-nb" when="init">
What other NetBeans projects and modules does this one depend on?
<hint>
Depending on other NetBeans projects influnces the ability of
users of your work to customize their own branded version of
NetBeans by enabling and disabling some modules. Too
much dependencies restrict this kind of customization. If that
is your case, then you may want to split your functionality into
pieces of autoload, eager and regular modules which can be
enabled independently. Usually the answer to this question
is generated from your <code>project.xml</code> file, but
if it is not guessed correctly, you can suppress it by
specifying <defaultanswer generate="none"/> and
write here your own. Please describe such projects as imported APIs using
the <code><api name="identification" type="import or export" category="stable" url="where is the description" /></code>.
By doing this information gets listed in the summary page of your
javadoc.
</hint>
</question>
-->
<answer id="dep-nb">
<defaultanswer generate='none' />
<ul>
<li><api type='import' group='java' category='official' name='org.openide.util'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.util.lookup'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.java.source'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.java.navigation'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.api.java'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.api.java.classpath'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.api.progress'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.libs.javacapi'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.editor'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='friend' name='org.netbeans.modules.editor.breadcrumbs'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.editor.lib'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.editor.lib2'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.editor.mimelookup'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.editor.settings'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.java.lexer'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.java.sourceui'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.lexer'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.parsing.api'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.projectapi'>
The module is needed for compilation.
4D1C
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.projectuiapi'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.refactoring.api'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.netbeans.modules.settings'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.actions'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.awt'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.explorer'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.loaders'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.nodes'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.text'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.filesystems'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
<li><api type='import' group='java' category='official' name='org.openide.windows'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
</ul>
</answer>
<!--
<question id="dep-non-nb" when="init">
What other projects outside NetBeans does this one depend on?
<hint>
Depending on 3rd party libraries is always problematic,
especially if they are not open source, as that complicates
the licensing scheme of NetBeans. Please enumerate your
external dependencies here, so it is correctly understood since
the begining what are the legal implications of your project.
Also please note that
some non-NetBeans projects are packaged as NetBeans modules
(see <a href="http://libs.netbeans.org/">libraries</a>) and
it is preferred to use this approach when more modules may
depend and share such third-party libraries.
</hint>
</question>
-->
<answer id="dep-non-nb">
<p>
No.
</p>
</answer>
<!--
<question id="dep-platform" when="init">
On which platforms does your module run? Does it run in the same
way on each?
<hint>
If you plan any dependency on OS or any usage of native code,
please describe why you are doing so and describe how you envision
to enforce the portability of your code.
Please note that there is a support for <a href="http://www.netbeans.org/download/dev/javadoc/org-openide-modules/org/openide/modules/doc-files/api.html#how-os-specific">OS conditionally
enabled modules</a> which together with autoload/eager modules
can allow you to enable to provide the best OS aware support
on certain OSes while providing compatibility bridge on the not
supported ones.
Also please list the supported
OSes/HW platforms and mentioned the lovest version of JDK required
for your project to run on. Also state whether JRE is enough or
you really need JDK.
</hint>
</question>
-->
<answer id="dep-platform">
<p>
Any.
</p>
</answer>
<!--
<question id="deploy-dependencies" when="final">
What do other modules need to do to declare a dependency on this one,
in addition to or instead of the normal module dependency declaration
(e.g. tokens to require)?
<hint>
Provide a sample of the actual lines you would add to a module manifest
to declare a dependency, for example OpenIDE-Module-Requires: some.token.
If other modules should not depend on this module, or should just use a
simple regular module dependency, you can just answer "nothing". If you
intentionally expose a semistable API to clients using implementation
dependencies, you should mention that here (but there is no need to give
an example of usage).
</hint>
</question>
-->
<answer id="deploy-dependencies">
<p>
Nothing.
</p>
</answer>
<!--
<question id="deploy-jar" when="impl">
Do you deploy just module JAR file(s) or other files as well?
<hint>
Usually a module consist of one JAR file (perhaps with Class-Path
extensions) and also a configuration file that enables it. If you
have any other files, use
<api group="java.io.File" name="yourname" type="export" category="friend">...</api>
to define the location, name and stability of your files (of course
changing "yourname" and "friend" to suit your needs).
If it uses more than one JAR, describe where they are located, how
they refer to each other.
If it consist of module JAR(s) and other files, please describe
what is their purpose, why other files are necessary. Please
make sure that installation/uninstallation leaves the system
in state as it was before installation.
</hint>
</question>
-->
<answer id="deploy-jar">
<p>
Just a Jar.
</p>
</answer>
<!--
<question id="deploy-nbm" when="impl">
Can you deploy an NBM via the Update Center?
<hint>
If not why?
</hint>
</question>
-->
<answer id="deploy-nbm">
<p>
Yes.
</p>
</answer>
<!--
<question id="deploy-packages" when="init">
Are packages of your module made inaccessible by not declaring them
public?
<hint>
By default NetBeans build harness treats all packages are private.
If you export some of them - either as public or friend packages,
you should have a reason. If the reason is described elsewhere
in this document, you can ignore this question.
</hint>
</question>
-->
<answer id="deploy-packages">
<p>
No packages exported.
</p>
</answer>
<!--
<question id="deploy-shared" when="final">
Do you need to be installed in the shared location only, or in the user directory only,
or can your module be installed anywhere?
<hint>
Installation location shall not matter, if it does explain why.
Consider also whether <code>InstalledFileLocator</code> can help.
</hint>
</question>
-->
<answer id="deploy-shared">
<p>
Anywhere.
</p>
</answer>
<!--
<question id="exec-ant-tasks" when="impl">
Do you define or register any ant tasks that other can use?
<hint>
If you provide an ant task that users can use, you need to be very
careful about its syntax and behaviour, as it most likely forms an
API for end users and as there is a lot of end users, their reaction
when such API gets broken can be pretty strong.
</hint>
</question>
-->
<answer id="exec-ant-tasks">
<p>
No.
</p>
</answer>
<!--
<question id="exec-classloader" when="impl">
Does your code create its own class loader(s)?
<hint>
A bit unusual. Please explain why and what for.
</hint>
</question>
-->
<answer id="exec-classloader">
<p>
No.
</p>
</answer>
<!--
<question id="exec-component" when="impl">
Is execution of your code influenced by any (string) property
of any of your components?
<hint>
Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code>
or <code>PropertyDescriptor.getValue</code>, etc. are used to influence
a behavior of some code. This of course forms an interface that should
be documented. Also if one depends on some interface that an object
implements (<code>component instanceof Runnable</code>) that forms an
API as well.
</hint>
</question>
-->
<answer id="exec-component">
<p>
No.
</p>
</answer>
<!--
<question id="exec-introspection" when="impl">
Does your module use any kind of runtime type information (<code>instanceof</code>,
work with <code>java.lang.Class</code>, etc.)?
<hint>
Check for cases when you have an object of type A and you also
expect it to (possibly) be of type B and do some special action. That
should be documented. The same applies on operations in meta-level
(Class.isInstance(...), Class.isAssignableFrom(...), etc.).
</hint>
</question>
-->
<answer id="exec-introspection">
<p>
No.
</p>
</answer>
<!--
<question id="exec-privateaccess" when="final">
Are you aware of any other parts of the system calling some of
your methods by reflection?
<hint>
If so, describe the "contract" as an API. Likely private or friend one, but
still API and consider rewrite of it.
</hint>
</question>
-->
<answer id="exec-privateaccess">
Yes, it uses reflection to call:
<ol>
<li>
<code>org.netbeans.modules.parsing.impl.indexing.friendapi.IndexingController.getBinaryRootDependencies</code>
</li>
<li>
<code>org.netbeans.modules.parsing.impl.indexing.friendapi.IndexingController.getRootDependencies</code>
</li>
<li>
<code>org.netbeans.modules.parsing.impl.indexing.RepositoryUpdater.getDependencies</code>
</li>
</ol>
</answer>
<!--
<question id="exec-process" when="impl">
Do you execute an external process from your module? How do you ensure
that the result is the same on different platforms? Do you parse output?
Do you depend on result code?
<hint>
If you feed an input, parse the output please declare that as an API.
</hint>
</question>
-->
<answer id="exec-process">
<p>
No.
</p>
</answer>
<!--
<question id="exec-property" when="impl">
Is execution of your code influenced by any environment or
Java system (<code>System.getProperty</code>) property?
<hint>
If there is a property that can change the behavior of your
code, somebody will likely use it. You should describe what it does
and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life">stability category</a>
of this API. You may use
<pre>
<api type="export" group="property" name="id" category="private" url="http://...">
description of the property, where it is used, what it influence, etc.
</api>
</pre>
</hint>
</question>
-->
<answer id="exec-property">
<p>
No.
</p>
</answer>
<!--
<question id="exec-reflection" when="impl">
Does your code use Java Reflection to execute other code?
<hint>
This usually indicates a missing or insufficient API in the other
part of the system. If the other side is not aware of your dependency
this contract can be easily broken.
</hint>
</question>
-->
<answer id="exec-reflection">
Yes, it uses reflection to call:
<ol>
<li>
<code>org.netbeans.modules.parsing.impl.indexing.friendapi.IndexingController.getBinaryRootDependencies</code>
</li>
<li>
<code>org.netbeans.modules.parsing.impl.indexing.friendapi.IndexingController.getRootDependencies</code>
</li>
<li>
<code>org.netbeans.modules.parsing.impl.indexing.RepositoryUpdater.getDependencies</code>
</li>
</ol>
</answer>
<!--
<question id="exec-threading" when="init">
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
<hint>
Is your API threadsafe? Can it be accessed from any threads or
just from some dedicated ones? Any special relation to AWT and
its Event Dispatch thread? Also
if your module calls foreign APIs which have a specific threading model,
indicate how you comply with the requirements for multithreaded access
(synchronization, mutexes, etc.) applicable to those APIs.
If your module defines any APIs, or has complex internal structures
that might be used from multiple threads, declare how you protect
data against concurrent access, race conditions, deadlocks, etc.,
and whether such rules are enforced by runtime warnings, errors, assertions, etc.
Examples: a class might be non-thread-safe (like Java Collections); might
be fully thread-safe (internal locking); might require access through a mutex
(and may or may not automatically acquire that mutex on behalf of a client method);
might be able to run only in the event queue; etc.
Also describe when any events are fired: synchronously, asynchronously, etc.
Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations">Threading Recommendations</a> (in progress)
</hint>
</question>
-->
<answer id="exec-threading">
<p>
Uses Parsing API defined threading.
</p>
</answer>
<!--
<question id="format-clipboard" when="impl">
Which data flavors (if any) does your code read from or insert to
the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>?
<hint>
Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
Check your code for overriding these methods.
</hint>
</question>
-->
<answer id="format-clipboard">
<p>
No.
</p>
</answer>
<!--
<question id="format-dnd" when="impl">
Which protocols (if any) does your code understand during Drag & Drop?
<hint>
Often Node's deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>.
Check your code for overriding these methods. Btw. if they are not overridden, they
by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>.
</hint>
</question>
-->
<answer id="format-dnd">
<p>
No.
</p>
</answer>
<!--
<question id="format-types" when="impl">
Which protocols and file formats (if any) does your module read or write on disk,
or transmit or receive over the network? Do you generate an ant build script?
Can it be edited and modified?
<hint>
<p>
Files can be read and written by other programs, modules and users. If they influence
your behaviour, make sure you either document the format or claim that it is a private
api (using the <api> tag).
</p>
<p>
If you generate an ant build file, this is very likely going to be seen by end users and
they will be attempted to edit it. You should be ready for that and provide here a link
to documentation that you have for such purposes and also describe how you are going to
understand such files during next release, when you (very likely) slightly change the
format.
</p>
</hint>
</question>
-->
<answer id="format-types">
<p>
None.
</p>
</answer>
<!--
<question id="lookup-lookup" when="init">
Does your module use <code>org.openide.util.Lookup</code>
or any similar technology to find any components to communicate with? Which ones?
<hint>
NetBeans is build around a generic registry of services called
lookup. It is preferable to use it for registration and discovery
if possible. See
<a href="http://www.netbeans.org/download/dev/javadoc/org-openide-util/org/openide/util/lookup/doc-files/index.html">
The Solution to Comunication Between Components
</a>. If you do not plan to use lookup and insist usage
of other solution, then please describe why it is not working for
you.
<br/>
When filling the final version of your arch document, please
describe the interfaces you are searching for, where
are defined, whether you are searching for just one or more of them,
if the order is important, etc. Also classify the stability of such
API contract. Use <api group=&lookup& /> tag, so
your information gets listed in the sum
4D1C
mary page of your javadoc.
</hint>
</question>
-->
<answer id="lookup-lookup">
<p>
Yes, it lookups global class loader.
</p>
</answer>
<!--
<question id="lookup-register" when="final">
Do you register anything into lookup for other code to find?
<hint>
Do you register using layer file or using <code>META-INF/services</code>?
Who is supposed to find your component?
</hint>
</question>
-->
<answer id="lookup-register">
<p>
Yes, it registers several instances of <code>JavaSourceTaskFactory</code>.
</p>
</answer>
<!--
<question id="lookup-remove" when="final">
Do you remove entries of other modules from lookup?
<hint>
Why? Of course, that is possible, but it can be dangerous. Is the module
your are masking resource from aware of what you are doing?
</hint>
</question>
-->
<answer id="lookup-remove">
<p>
None.
</p>
</answer>
<!--
<question id="perf-exit" when="final">
Does your module run any code on exit?
</question>
-->
<answer id="perf-exit">
<p>
No.
</p>
</answer>
<!--
<question id="perf-huge_dialogs" when="final">
Does your module contain any dialogs or wizards with a large number of
GUI controls such as combo boxes, lists, trees, or text areas?
</question>
-->
<answer id="perf-huge_dialogs">
<p>
Yes.
</p>
</answer>
<!--
<question id="perf-limit" when="init">
Are there any hard-coded or practical limits in the number or size of
elements your code can handle?
<hint>
Most of algorithms have increasing memory and speed complexity
with respect to size of data they operate on. What is the critical
part of your project that can be seen as a bottleneck with
respect to speed or required memory? What are the practical
sizes of data you tested your project with? What is your estimate
of potential size of data that would cause visible performance
problems? Is there some kind of check to detect such situation
and prevent "hard" crashes - for example the CloneableEditorSupport
checks for size of a file to be opened in editor
and if it is larger than 1Mb it shows a dialog giving the
user the right to decide - e.g. to cancel or commit suicide.
</hint>
</question>
-->
<answer id="perf-limit">
<p>
No.