Google Git
Sign in
apache / netbeans-docs / refs/heads/asf-site / . / content / 9.0 / javadoc / org-openide-execution / architecture-summary.html
blob: aa6b78a3a6ad6b90b0ad2b2620573d46efa72fa7 [file] [log] [blame]
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Execution API - NetBeans Architecture Questions</title>
<link rel="stylesheet" type="text/css" href="prose.css">
</head>
<body>
<p class="overviewlink">
<a href="overview-summary.html">Overview</a>
</p>
<h1>NetBeans Architecture Answers for Execution API module</h1>
<ul>
<li>
<b>Author:</b> dstrupl@netbeans.org</li>
<li>
<b>Answers as of:</b> 14-Sep-2018</li>
<li>
<b>Answers for questions version:</b> 1.12</li>
<li>
<b>Latest available version of questions:</b> 1.29</li>
</ul>
<strong>
WARNING: answering questions version 1.12
rather than the current 1.29.
</strong>
<hr>
<h2>Interfaces table</h2>
<a name="group-java">
<h5>Group of java interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>ExecutionAPI</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-ExecutionAPI"><a href="../org-openide-execution/org/openide/execution/doc-files/api.html">
.../org/openide/execution/doc-files/api.html</a>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>OptionsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-OptionsAPI"><a href="../org-openide-options/org/openide/options/doc-files/api.html">
.../org/openide/options/doc-files/api.html</a>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>WindowSystemAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-WindowSystemAPI"><a href="../org-openide-windows/org/openide/windows/doc-files/api.html">
.../org/openide/windows/doc-files/api.html</a>
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>FilesystemsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-FilesystemsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.0
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>InputOutputAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-InputOutputAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.0
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>UtilitiesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-UtilitiesAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>WeakListener.setAccessible</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java-WeakListener.setAccessible">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>LookupAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-LookupAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
8.0
is required.
<p></p>
</a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<a name="group-property">
<h5>Group of property interfaces</h5>
</a>
<table cellpadding="1" cellspacing="0" border="0" class="tablebg" width="100%">
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="1" width="100%">
<tr class="tablersh">
<td align="CENTER" width="25%"><span class="titlectable">Interface Name</span></td><td align="CENTER" width="10%"><span class="titlectable">In/Out</span></td><td align="CENTER" width="10%"><span class="titlectable">Stability</span></td><td align="CENTER"><span class="titlectable">Specified in What Document?</span></td>
</tr>
<tr class="tabler">
<td>NetBeansAttrExecutor</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-NetBeansAttrExecutor"></a></td>
</tr>
<tr class="tabler">
<td>NetBeansAttrArguments</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-NetBeansAttrArguments"></a></td>
</tr>
<tr class="tabler">
<td>readOnlyAttrs</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-readOnlyAttrs"></a></td>
</tr>
<tr class="tabler">
<td>Env-foo</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-Env-foo"></a></td>
</tr>
<tr class="tabler">
<td>java.home</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Standard">Standard</a></td><td><a name="property-java.home"></a></td>
</tr>
<tr class="tabler">
<td>jdk.home</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Standard">Standard</a></td><td><a name="property-jdk.home"></a></td>
</tr>
<tr class="tabler">
<td>java.class.path</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Standard">Standard</a></td><td><a name="property-java.class.path"></a></td>
</tr>
<tr class="tabler">
<td>sun.boot.class.path</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-sun.boot.class.path"></a></td>
</tr>
<tr class="tabler">
<td>java.ext.dirs</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-java.ext.dirs"></a></td>
</tr>
<tr class="tabler">
<td>line.separator</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="property-line.separator"></a></td>
</tr>
</table>
</td>
</tr>
</table>
<p></p>
<!--
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.
-->
<!-- XXX need to remove obsolete info from Execution API split -->
<api-answers author="dstrupl@netbeans.org" module="Execution API" question-version="1.12">
<!--
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.
-->
<!--
Author : Jaroslav Tulach, Jesse Glick
Description: Questions that should be answered in order to make better API
No PUBLIC or SYSTEM IDs defined currently.
-->
<!--
*** ATTENTION EDITORS ***
Please increment the 'version' field of <api-questions> whenever you make a
semantic change: adding a new question or significantly changing the meaning of
an old one. Changing this field ensures that arch pages answering the old version
print a warning during Javadoc generation. If you only change hints or make small
edits in the text of a question, you need not change the version number.
An automated process runs openide/www/tutorial/build.xml#question periodically
and commits any changes to openide/www/tutorial/questions.html.
-->
<api-questions version="1.29" xml:base="file:/home/nsigma/Code/NetBeans/incubator-netbeans/nbbuild/antsrc/org/netbeans/nbbuild/Arch-api-questions.xml">
<hr>
<h2>General Information</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-arch-what">Question (arch-what)</a>:</b><em>
What is this project good for?
</em></font>
<p></p>
<b>Answer:</b>
The IDE uses a small interface to describe the execution of Java-based
classes together with arguments. The
<a href="#java-ExecutionAPI">ExecutionAPI</a>
controls the execution
of user-level classes. The system may have several different types
of executors simultaneously installed. By default we provide so called
External Execution for running a user code by an external process and
Internal Execution for running the user code in the same virtual machine
as the IDE.
<p></p>
<font color="gray"><b><a name="answer-arch-overall">Question (arch-overall)</a>:</b><em>
Describe the overall architecture.
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>arch-overall</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-arch-usecases">Question (arch-usecases)</a>:</b><em>
Describe the main <a href="http://wiki.netbeans.org/API_Design#The_Importance_of_Being_Use_Case_Oriented" shape="rect">
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?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>arch-usecases</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-arch-time">Question (arch-time)</a>:</b><em>
What are the time estimates of the work?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>arch-time</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-arch-quality">Question (arch-quality)</a>:</b><em>
How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html" shape="rect">quality</a>
of your code be tested and
how are future regressions going to be prevented?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>arch-quality</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-arch-where">Question (arch-where)</a>:</b><em>
Where one can find sources for your module?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>arch-where</i>" has not been answered!</ul>
<hr>
<h2>Project and platform dependencies</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-dep-nb">Question (dep-nb)</a>:</b><em>
What other NetBeans projects and modules does this one depend on?
</em></font>
<p></p>
<b>Answer:</b>
<a href="#java-OptionsAPI">OptionsAPI</a>;
<a href="#java-WindowSystemAPI">WindowSystemAPI</a>
<p>The default answer to this question is:<!--If you do not want default answer to be generated you can use <defaultanswer generate='none' /> here--><br>
<p>
<p>
These modules are required in project.xml:
<!--<li><api type='import' group='java' category='official' name='FilesystemsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.0
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='InputOutputAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.0
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='UtilitiesAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='devel' name='WeakListener.setAccessible'>
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='LookupAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
8.0
is required.
</api>
</li>
--><ul>
<li>
<a href="#java-FilesystemsAPI">FilesystemsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.0
is required.
</li>
<li>
<a href="#java-InputOutputAPI">InputOutputAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.0
is required.
</li>
<li>
<a href="#java-UtilitiesAPI">UtilitiesAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</li>
<li>
<a href="#java-WeakListener.setAccessible">WeakListener.setAccessible</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
9.3
is required.
</li>
<li>
<a href="#java-LookupAPI">LookupAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
8.0
is required.
</li>
</ul>
</p>
</p>
</p>
<p></p>
<font color="gray"><b><a name="answer-dep-non-nb">Question (dep-non-nb)</a>:</b><em>
What other projects outside NetBeans does this one depend on?
</em></font>
<p></p>
<b>Answer:</b>
Execution does not depend on any external library.
<p></p>
<font color="gray"><b><a name="answer-dep-platform">Question (dep-platform)</a>:</b><em>
On which platforms does your module run? Does it run in the same
way on each?
</em></font>
<p></p>
<b>Answer:</b>
For running with so called external execution the java process is
spawned. The module tries to find the java executable. It uses the
same executable as the whole NetBeans IDE.
<p></p>
<font color="gray"><b><a name="answer-dep-jre">Question (dep-jre)</a>:</b><em>
Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
</em></font>
<p></p>
<b>Answer:</b>
1.3.
<p></p>
<font color="gray"><b><a name="answer-dep-jrejdk">Question (dep-jrejdk)</a>:</b><em>
Do you require the JDK or is the JRE enough?
</em></font>
<p></p>
<b>Answer:</b>
JRE is enough.
</ul>
<hr>
<h2>Deployment</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-deploy-jar">Question (deploy-jar)</a>:</b><em>
Do you deploy just module JAR file(s) or other files as well?
</em></font>
<p></p>
<b>Answer:</b>
The module creates openide-execution.jar and core-execution.jar. Both of them
are autoload modules. The openide-execution.jar contains the public APIs
and the core-execution.jar contains private implementation.
<p></p>
<font color="gray"><b><a name="answer-deploy-nbm">Question (deploy-nbm)</a>:</b><em>
Can you deploy an NBM via the Update Center?
</em></font>
<p></p>
<b>Answer:</b>
Yes.
<p></p>
<font color="gray"><b><a name="answer-deploy-shared">Question (deploy-shared)</a>:</b><em>
Do you need to be installed in the shared location only, or in the user directory only,
or can your module be installed anywhere?
</em></font>
<p></p>
<b>Answer:</b>
No answer
<p></p>
<font color="gray"><b><a name="answer-deploy-packages">Question (deploy-packages)</a>:</b><em>
Are packages of your module made inaccessible by not declaring them
public?
</em></font>
<p></p>
<b>Answer:</b>
core-execution.jar does not define any public packages. So the public classes
in this jar are made inaccessible by the NetBeans module system.
openide-execution.jar contains publicly accessible classes (no protection
by the module system needed in this case).
<p></p>
<font color="gray"><b><a name="answer-deploy-dependencies">Question (deploy-dependencies)</a>:</b><em>
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)?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>deploy-dependencies</i>" has not been answered!</ul>
<hr>
<h2>Compatibility with environment</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-compat-i18n">Question (compat-i18n)</a>:</b><em>
Is your module correctly internationalized?
</em></font>
<p></p>
<b>Answer:</b>
Yes.
<p></p>
<font color="gray"><b><a name="answer-compat-standards">Question (compat-standards)</a>:</b><em>
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-compat-version">Question (compat-version)</a>:</b><em>
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?
</em></font>
<p></p>
<b>Answer:</b>
Yes. It uses the settings API to store its settings.
<p></p>
<font color="gray"><b><a name="answer-compat-deprecation">Question (compat-deprecation)</a>:</b><em>
How the introduction of your project influences functionality
provided by previous version of the product?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>compat-deprecation</i>" has not been answered!</ul>
<hr>
<h2>Access to resources</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-resources-file">Question (resources-file)</a>:</b><em>
Does your module use <code>java.io.File</code> directly?
</em></font>
<p></p>
<b>Answer:</b>
Yes. It uses java.io.File representing items on classpath (NbClassPath).
<p></p>
<font color="gray"><b><a name="answer-resources-layer">Question (resources-layer)</a>:</b><em>
Does your module provide own layer? Does it create any files or
folders in it? What it is trying to communicate by that and with which
components?
</em></font>
<p></p>
<b>Answer:</b>
Yes. It provides its own layer. It creates menu items, services, templates
and window system components.
<p></p>
<font color="gray"><b><a name="answer-resources-read">Question (resources-read)</a>:</b><em>
Does your module read any resources from layers? For what purpose?
</em></font>
<p></p>
<b>Answer:</b>
No answer
<p></p>
<font color="gray"><b><a name="answer-resources-mask">Question (resources-mask)</a>:</b><em>
Does your module mask/hide/override any resources provided by other modules in
their layers?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-resources-preferences">Question (resources-preferences)</a>:</b><em>
Does your module uses preferences via Preferences API? Does your module use NbPreferences or
or regular JDK Preferences ? Does it read, write or both ?
Does it share preferences with other modules ? If so, then why ?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>resources-preferences</i>" has not been answered!</ul>
<hr>
<h2>Lookup of components</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-lookup-lookup">Question (lookup-lookup)</a>:</b><em>
Does your module use <code>org.openide.util.Lookup</code>
or any similar technology to find any components to communicate with? Which ones?
</em></font>
<p></p>
<b>Answer:</b>
<ul>
<li>ClassLoader.class</li>
<li>ServiceType.Registry.class</li>
<li>ExecutionEngine.class</li>
<li>ScriptType.class</li>
</ul>
<p></p>
<font color="gray"><b><a name="answer-lookup-register">Question (lookup-register)</a>:</b><em>
Do you register anything into lookup for other code to find?
</em></font>
<p></p>
<b>Answer:</b>
In META-INF/services:
<ul>
<li>java.net.URLStreamHandlerFactory</li>
<li>org.openide.execution.ExecutionEngine</li>
</ul>
<p></p>
<font color="gray"><b><a name="answer-lookup-remove">Question (lookup-remove)</a>:</b><em>
Do you remove entries of other modules from lookup?
</em></font>
<p></p>
<b>Answer:</b>
No.
</ul>
<!-- classification of interfaces -->
<!-- package names -->
<hr>
<h2>Execution Environment</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-exec-property">Question (exec-property)</a>:</b><em>
Is execution of your code influenced by any environment or
Java system (<code>System.getProperty</code>) property?
On a similar note, is there something interesting that you
pass to <code>java.util.logging.Logger</code>? Or do you observe
what others log?
</em></font>
<p></p>
<b>Answer:</b>
Following is the list of properties used by the Execution module
<a href="#property-Env-foo">Env-foo</a>
<a href="#property-java.home">java.home</a>
<a href="#property-jdk.home">jdk.home</a>
<a href="#property-java.class.path">java.class.path</a>
<a href="#property-sun.boot.class.path">sun.boot.class.path</a>
<a href="#property-java.ext.dirs">java.ext.dirs</a>
<a href="#property-line.separator">line.separator</a>
<p></p>
<font color="gray"><b><a name="answer-exec-component">Question (exec-component)</a>:</b><em>
Is execution of your code influenced by any (string) property
of any of your components?
</em></font>
<p></p>
<b>Answer:</b>
File attributes accessible via calls to
org.openide.filesystems.FileObject.getAttribute(name)
org.openide.filesystems.FileObject.setAttribute(name, value)
They can also be stored in the module layer. Please see filesystems
for more information about this.
<a href="#property-NetBeansAttrExecutor">NetBeansAttrExecutor</a>
<a href="#property-NetBeansAttrArguments">NetBeansAttrArguments</a>
<a href="#property-readOnlyAttrs">readOnlyAttrs</a>
<p></p>
<font color="gray"><b><a name="answer-exec-ant-tasks">Question (exec-ant-tasks)</a>:</b><em>
Do you define or register any ant tasks that other can use?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>exec-ant-tasks</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-exec-classloader">Question (exec-classloader)</a>:</b><em>
Does your code create its own class loader(s)?
</em></font>
<p></p>
<b>Answer:</b>
Yes --- this module creates its own class loader. NbClassLoader is in the
public API and it is a class loader which is capable of loading classes
from the Repository (a user defined dynamic class path).
<p></p>
<font color="gray"><b><a name="answer-exec-reflection">Question (exec-reflection)</a>:</b><em>
Does your code use Java Reflection to execute other code?
</em></font>
<p></p>
<b>Answer:</b>
Hack to close windows belonging to a thread group uses method
javax.swing.SwingUtilities.getSharedOwnerFrame.<p></p>
The field
java.security.AccessControlContext.context is accessed due
to some JDK 1.2.1 hack in org.netbeans.core.execution.AccController.<p></p>
When you want to execute some object it is first compiled.
<p></p>
<font color="gray"><b><a name="answer-exec-privateaccess">Question (exec-privateaccess)</a>:</b><em>
Are you aware of any other parts of the system calling some of
your methods by reflection?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-exec-process">Question (exec-process)</a>:</b><em>
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?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>exec-process</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-exec-introspection">Question (exec-introspection)</a>:</b><em>
Does your module use any kind of runtime type information (<code>instanceof</code>,
work with <code>java.lang.Class</code>, etc.)?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>exec-introspection</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-exec-threading">Question (exec-threading)</a>:</b><em>
What threading models, if any, does your module adhere to? How the
project behaves with respect to threading?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>exec-threading</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-security-policy">Question (security-policy)</a>:</b><em>
Does your functionality require modifications to the standard policy file?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>security-policy</i>" has not been answered!<p></p>
<font color="gray"><b><a name="answer-security-grant">Question (security-grant)</a>:</b><em>
Does your code grant additional rights to some other code?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>security-grant</i>" has not been answered!</ul>
<hr>
<h2>Format of files and protocols</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-format-types">Question (format-types)</a>:</b><em>
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?
</em></font>
<p></p>
<b>Answer:</b>
No answer
<p></p>
<font color="gray"><b><a name="answer-format-dnd">Question (format-dnd)</a>:</b><em>
Which protocols (if any) does your code understand during Drag &amp; Drop?
</em></font>
<p></p>
<b>Answer:</b>
None.
<p></p>
<font color="gray"><b><a name="answer-format-clipboard">Question (format-clipboard)</a>:</b><em>
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>?
</em></font>
<p></p>
<b>Answer:</b>
None.
</ul>
<hr>
<h2>Performance and Scalability</h2>
<ul>
<p></p>
<font color="gray"><b><a name="answer-perf-startup">Question (perf-startup)</a>:</b><em>
Does your module run any code on startup?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-perf-exit">Question (perf-exit)</a>:</b><em>
Does your module run any code on exit?
</em></font>
<p></p>
<b>Answer:</b>
Yes. It runs a dialog prompting the user to shut down the external
processes.
<p></p>
<font color="gray"><b><a name="answer-perf-scale">Question (perf-scale)</a>:</b><em>
Which external criteria influence the performance of your
program (size of file in editor, number of files in menu,
in source directory, etc.) and how well your code scales?
</em></font>
<p></p>
<b>Answer:</b>
The code should scale linarly with number of running processes.
<p></p>
<font color="gray"><b><a name="answer-perf-limit">Question (perf-limit)</a>:</b><em>
Are there any hard-coded or practical limits in the number or size of
elements your code can handle?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-perf-mem">Question (perf-mem)</a>:</b><em>
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</em></font>
<p></p>
<b>Answer:</b>
No answer
<p></p>
<font color="gray"><b><a name="answer-perf-wakeup">Question (perf-wakeup)</a>:</b><em>
Does any piece of your code wake up periodically and do something
even when the system is otherwise idle (no user interaction)?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-perf-progress">Question (perf-progress)</a>:</b><em>
Does your module execute any long-running tasks?
</em></font>
<p></p>
<b>Answer:</b>
The module executes external processes. It does not block the AWT thread.
<p></p>
<font color="gray"><b><a name="answer-perf-huge_dialogs">Question (perf-huge_dialogs)</a>:</b><em>
Does your module contain any dialogs or wizards with a large number of
GUI controls such as combo boxes, lists, trees, or text areas?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-perf-menus">Question (perf-menus)</a>:</b><em>
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated and slow enablement logic?
</em></font>
<p></p>
<b>Answer:</b>
No.
<p></p>
<font color="gray"><b><a name="answer-perf-spi">Question (perf-spi)</a>:</b><em>
How the performance of the plugged in code will be enforced?
</em></font>
<p></p>
<b>WARNING:</b> Question with id="<i>perf-spi</i>" has not been answered!</ul>
<!-- security -->
<!-- recovery -->
</api-questions>
<!--
<question id="arch-what">
What is this project good for?
<hint>
Please provide here few lines describing the the project,
what problem it should solve, provide links to documentation,
specifications, etc.
</hint>
</question>
-->
<!--
<question id="compat-i18n">
Is your module correctly internationalized?
<hint>
Correct internationalization means that it obeys instuctions
at <a href="http://www.netbeans.org/devhome/docs/i18n/index.html">
NetBeans I18N pages</a>.
</hint>
</question>
-->
<!--
<question id="compat-standards">
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</question>
-->
<!--
<question id="compat-version">
Can your module coexist with earlier and future
versions? 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>
-->
<!--
<question id="dep-jre">
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>
-->
<!--
<question id="dep-jrejdk">
Do you require the JDK or is the JRE enough?
</question>
-->
<!--
<question id="dep-nb">
What other NetBeans projects does this one depend on?
<hint>
If you want, describe such projects as imported API using
the <code>&lt;api name="identification" type="import or export" category="stable" url="where is the description" /&gt;</code>
</hint>
</question>
-->
<!--
<question id="dep-non-nb">
What other projects outside NetBeans does this one depend on?
<hint>
Some non-NetBeans projects are packaged as NetBeans modules
(see <a href="http://libs.netbeans.org">libraries</a>) and
it is prefered to use this approach when more modules may
depend on such third-party library.
</hint>
</question>
-->
<!--
<question id="dep-platform">
On which platforms does your module run? Does it run in the same
way on each?
<hint>
If your module is using JNI or deals with special differences of
OSes like filesystems, etc. please describe here what they are.
</hint>
</question>
-->
<!--
<question id="deploy-jar">
Do you deploy just module JAR file(s) or other files as well?
<hint>
If your module consist just from one module JAR file, just confirm that.
If it uses more than one JAR, describe where there 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/deinstallation leaves the system
in state as it was before installation.
</hint>
</question>
-->
<!--
<question id="deploy-nbm">
Can you deploy an NBM via the Update Center?
<hint>
If not why?
</hint>
</question>
-->
<!--
<question id="deploy-packages">
Are packages of your module made inaccessible by not declaring them
public?
<hint>
NetBeans module system allows restriction of access rights to
public classes of your module from other modules. This prevents
unwanted dependencies of others on your code and should be used
whenever possible (<a href="http://www.netbeans.org/download/apis/org/openide/doc-files/upgrade.html#3.4-public-packages">
public packages
</a>).
</hint>
</question>
-->
<!--
<question id="deploy-shared">
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>
-->
<!--
<question id="exec-classloader">
Does your code create its own class loader(s)?
<hint>
A bit unusual. Please explain why and what for.
</hint>
</question>
-->
<!--
<question id="exec-component">
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 behaviour 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>
-->
<!--
<question id="exec-privateaccess">
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>
-->
<!--
<question id="exec-property">
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 behaviour of your
code, somebody will likely use it. You should describe what it does
and the stability category of this API. You may use
<pre>
&lt;property name="id" category="private" &gt;
description of the property, where it is used, what it influence, etc.
&lt;/property&gt;
</pre>
</hint>
</question>
-->
<!--
<question id="exec-reflection">
Does your code use Java Reflection to execute other code?
<hint>
This usually indicates a missing or unsufficient 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>
-->
<!--
<question id="format-clipboard">
Which data flavors (if any) does your code read from or insert to
the clipboard?
</question>
-->
<!--
<question id="format-dnd">
Which protocols (if any) does your code understand during Drag &amp; Drop?
</question>
-->
<!--
<question id="format-types">
Which file formats (if any) does your code read or write on disk?
</question>
-->
<!--
<question id="lookup-lookup">
Does your module use <code>org.openide.util.Lookup</code>
to find any components to communicate with? Which ones?
<hint>
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 clasify the stability of such
API contract.
</hint>
</question>
-->
<!--
<question id="lookup-register">
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>
-->
<!--
<question id="lookup-remove">
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>
-->
<!--
<question id="perf-exit">
Does your module run any code on exit?
</question>
-->
<!--
<question id="perf-huge_dialogs">
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>
-->
<!--
<question id="perf-limit">
Are there any hardcoded or practical limits in the number or size of
elements your code can handle?
</question>
-->
<!--
<question id="perf-mem">
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</question>
-->
<!--
<question id="perf-menus">
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated enablement logic?
</question>
-->
<!--
<question id="perf-progress">
Does your module execute any long-running tasks?
<hint>Typically they are tasks like connecting over
network, computing huge amount of data, compilation.
Such communication should be done asynchronously (for example
using <code>RequestProcessor</code>), definitively it should
not block AWT thread.
</hint>
</question>
-->
<!--
<question id="perf-scale">
Which external criteria influence the performance of your
program (size of file in editor, number of files in menu,
in source directory, etc.) and how well your code scales?
Please include some estimates.
</question>
-->
<!--
<question id="perf-startup">
Does your module run any code on startup?
</question>
-->
<!--
<question id="perf-wakeup">
Does any piece of your code wake up periodically and do something
even when the system is otherwise idle (no user interaction)?
</question>
-->
<!--
<question id="resources-file">
Does your module use <code>java.io.File</code> directly?
<hint>
NetBeans provide a logical wrapper over plain files called
<code>org.openide.filesystems.FileObject</code> that
provides uniform access to such resources and is the prefered
way that should be used. But of course there can be situations when
this is not suitable.
</hint>
</question>
-->
<!--
<question id="resources-layer">
Does your module provide own layer? Does it create any files or
folders in it? What it is trying to communicate by that and with which
components?
<hint>
NetBeans allows automatic and declarative installation of resources
by module layers. Module register files into appropriate places
and other components use that information to perform their task
(build menu, toolbar, window layout, list of templates, set of
options, etc.).
</hint>
</question>
-->
<!--
<question id="resources-mask">
Does your module mask/hide/override any resources provided by other modules in
their layers?
<hint>
If you mask a file provided by another module, you probably depend
on that and do not want the other module to (for example) change
the file's name. That module shall thus make that file available as an API
of some stability category.
</hint>
</question>
-->
<!--
<question id="resources-read">
Does your module read any resources from layers? For what purpose?
<hint>
As this is some kind of intermodule dependency, it is a kind of API.
Please describe it and clasify according to
<a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
common stability categories</a>.
</hint>
</question>
-->
</api-answers>
<hr>
<p><span class="footnote">Built on September 14 2018.&nbsp;&nbsp;|&nbsp;&nbsp; Copyright &#169; 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p>
</body>
</html>