Google Git
Sign in
apache / netbeans-docs / refs/heads/asf-site / . / content / 9.0 / javadoc / org-netbeans-modules-editor-fold / architecture-summary.html
blob: 3af23f4299ff1daded55e79a5ae5882e2e745501 [file] [log] [blame]
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Editor Code Folding - 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 Editor Code Folding module</h1>
<ul>
<li>
<b>Author:</b> mmetelka@netbeans.org</li>
<li>
<b>Answers as of:</b> 14-Sep-2018</li>
<li>
<b>Answers for questions version:</b> 1.24</li>
<li>
<b>Latest available version of questions:</b> 1.29</li>
</ul>
<strong>
WARNING: answering questions version 1.24
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>CodeFoldingAPI</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-CodeFoldingAPI"></a></td>
</tr>
<tr class="tabler">
<td>MimeLookupAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-MimeLookupAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.31
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>EditorSettingsAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-EditorSettingsAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.32
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>EditorUtilitiesAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java-EditorUtilitiesAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>LexerAPI</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-LexerAPI">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.50
is required.
<p></p>
</a></td>
</tr>
<tr class="tabler">
<td>org.netbeans.modules.editor.settings.lib</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Private">Private</a></td><td><a name="java-org.netbeans.modules.editor.settings.lib">
<p></p>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.39
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>
<!--
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.
-->
<api-answers author="mmetelka@netbeans.org" module="Editor Code Folding" question-version="1.24">
<!--
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 Code Folding is part of the editor module functionality and it's responsible for hiding of the portions
of the code that are less important for the user at the given time.
<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>Answer:</b>
The Code Folding was created to address requirements
described in
<a href="http://ui.netbeans.org/docs/ui/code_folding/cf_uispec.html" shape="rect">
Code Folding UI Specification
</a>
<p>
It is a module located under /cvs/editor/fold directory.
</p>
<p>
It consists of
</p>
<ul>
<li>API in org.netbeans.api.editor.fold</li>
<li>SPI in org.netbeans.spi.editor.fold</li>
<li>Implementation in org.netbeans.modules.editor.fold</li>
</ul>
Code Folding defines <a href="#java-CodeFoldingAPI">CodeFoldingAPI</a>.
<p>
The Javadoc documentation can be generated by using
</p>
<pre xml:space="preserve">
cd /cvs/editor/fold
ant javadoc
</pre>
<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>Answer:</b>
<h2>
API Use Cases
</h2>
<h3>
Exploring of the Folds
</h3>
<p>
The code folding structure (fold hierarchy) relates
to <code>javax.swing.JTextComponent</code> instance in one-to-one relationship.
<br>
To find the code folding hierarchy instance for the given non-null text component
the following code snippet can be used:
</p>
<pre xml:space="preserve">
JTextComponent editorComponent = ...
FoldHierarchy hierarchy = FoldHierarchy.get(editorComponent);
</pre>
<h3>
Explore the Folds Hierarchy
</h3>
<p>
The tree-based hierarchy has one non-removable and non-collapsable root fold
that covers the whole document. It can be obtained by
</p>
<pre xml:space="preserve">
FoldHierarchy foldHierarchy = ...
Fold rootFold = hierarchy.getRootFold();
</pre>
<p>
The children folds of the root fold (or children folds)
can be obtained by
</p>
<pre xml:space="preserve">
// the hierarchy must be locked prior exploration or manipulation
hierarchy.lock();
try {
Fold rootFold = ...
int foldCount = rootFold.getFoldCount();
for (int i = 0; i &lt; foldCount; i++) {
Fold childFold = rootFold.getFold(i);
}
} finally {
hierarchy.unlock();
}
</pre>
<p>
Index of the child in its parent can be found by
</p>
<pre xml:space="preserve">
hierarchy.lock();
try {
Fold rootFold = ...
int foldIndex = rootFold.getFoldIndex(childFold);
} finally {
hierarchy.unlock();
}
</pre>
<h3>
Collapse Nearest Fold
</h3>
<p>
In the given fold hierarchy find the nearest fold right at or after the given offset
and collapse it.
</p>
<pre xml:space="preserve">
hierarchy.lock();
try {
Fold fold = FoldUtilities.findNearestFold(hierarchy, offset);
hierarchy.collapse(fold);
} finally {
hierarchy.unlock();
}
</pre>
<h3>
Expand All Folds
</h3>
<p>
In the given fold hierarchy expand all folds that are currently collapsed.
</p>
<pre xml:space="preserve">
FoldUtilities.expand(hierarchy, null);
</pre>
<h3>
Collapse All Folds of Certain Type
</h3>
<p>
In the given fold hierarchy collapse all e.g. javadoc folds that are currently collapsed.
<br>
The example can be generalized to any fold type.
</p>
<pre xml:space="preserve">
FoldUtilities.collapse(hierarchy, JAVADOC_FOLD_TYPE);
</pre>
<h3>
Start Listening on Fold Hierarchy Changes
</h3>
<p>
In the given fold hierarchy start to listen on all changes
done in the hierarchy.
<br>
This is actually used e.g. in the Editor's View Hierarchy that needs
to refresh views based on the fold changes.
</p>
<pre xml:space="preserve">
hierarchy.addFoldHierarchyListener(new FoldHierarchyListener() {
public void foldHierarchyChanged(FoldHierarchyEvent evt) {
// Hierarchy does not need to be locked here
//
// evt.getAffectedStartOffset() and getAffectedEndOffset()
// give text area affected by the fold changes in the event
}
});
</pre>
<h3>
Inspect Collapsed Folds in Affected Area
</h3>
<p>
Listen on the hierarchy changes
and refresh the views in the text area affected by the fold change.
<br>
Inspect the collapsed folds in the affected area
because special views need to be created for the collapsed folds.
<br>
The actual code in the View Hierarchy is somewhat different
but the one given here is more descriptive.
</p>
<pre xml:space="preserve">
hierarchy.addFoldHierarchyListener(new FoldHierarchyListener() {
public void foldHierarchyChanged(FoldHierarchyEvent evt) {
for (Iterator collapsedFoldIterator
= FoldUtilities.collapsedFoldIterator(hierarchy,
evt.getAffectedStartOffset(),
evt.getAffectedEndOffset()
);
it.hasNext();
) {
Fold collapsedFold = (Fold)it.next();
// Create special view for the collapsedFold
}
}
});
</pre>
<h2>
SPI Use Cases
</h2>
<h3>
Create a New Fold Manager
</h3>
<p>
Manipulation of the folds is designed to be done by fold managers.
<br>
Those classes implement <code>FoldManager</code> interface in the SPI.
<br>
At initialization time they are given instance of <code>FoldOperation</code>
through which they can create, add or remove the fold instances.
</p>
<p>
To create and use a new <code>FoldManager</code> instance
it's necessary to
</p>
<ul>
<li> Define the class of the FoldManager.
<pre xml:space="preserve">
public class MyFoldManager implements FoldManager { // or extends AbstractFoldManager
...
}
</pre>
</li>
<li> Create FoldManagerFactory for the FoldManager.
<pre xml:space="preserve">
public class MyFoldManager ...
...
public static final class Factory implements FoldManagerFactory {
public FoldManager createFoldManager() {
return new MyFoldManager();
}
}
}
</pre>
</li>
<li> Register FoldManagerFactory into xml layer into the directory
"Editors/&lt;mime-type&gt;/FoldManager/"
</li>
<li> Enable Code Folding in editor's Settings initializer
(please see e.g. <code>NbJavaSettingsInitializer</code>)
<pre xml:space="preserve">
public class MySettingsInitializer ...
public void updateSettingsMap(Class kitClass, Map settingsMap) {
...
settingsMap.put(SettingsNames.CODE_FOLDING_ENABLE, Boolean.TRUE);
}
}
</pre>
</li>
</ul>
<h3>
Create a New Fold by Fold Manager
</h3>
<p>
Create a new fold and add it to the hierarchy. The operation
is performed by the fold manager either at initialization phase
(in the <code>initFolds()</code> which gets called automatically
by the infrastructure) or at any other time when the fold manager's
operation gets invoked (usually by a listener that the fold manager
attaches to be notified about changes that can cause the folds structure
to be changed - e.g. a parsing listener for java folds).
</p>
<p>
Operations that manipulate the hierarchy are done
in terms of a valid transaction over the fold hierarchy.
<br>
Transactions allow to fire the collected changes as a single
<code>FoldHierarchyEvent</code> at the time when they are committed.
</p>
<pre xml:space="preserve">
// In the FoldManager's context
FoldOperation operation = getOperation();
FoldHierarchyTransaction transaction = operation.openTransaction();
try {
Fold fold = operation.createFold(...);
operation.addFoldToHierarchy(fold, transaction);
} finally {
transaction.commit();
}
</pre>
<h3>
Remove Fold from Hierarchy by Fold Manager
</h3>
<p>
Remove the existing fold from the hierarchy
</p>
<pre xml:space="preserve">
// In the FoldManager's context
FoldOperation operation = getOperation();
FoldHierarchyTransaction transaction = operation.openTransaction();
try {
Fold fold = ...
operation.removeFoldFromHierarchy(fold, transaction);
} finally {
transaction.commit();
}
</pre>
<h3>Updating Fold hierarchy</h3>
In the preceding cases, maintaining Folds was the FoldManager's responsibility. The FoldManager typically
held a copy of the Folds added to the hierarchy, and during the refresh, it compared them to the new data
and decided what folds to remove.
For simple cases, which only create/remove folds based on text positions, part of the work can be offloaded to the
FoldOperation:
<pre xml:space="preserve">
// create new fold positional information for all folds.
Collection&lt;FoldInfo&gt; newInfos = ...;
// create FoldInfo for each of the fold
newInfos.add(
FoldInfo.range(start, end, type).
withTemplate(customTemplate).
withDescription(veryCustomDescription).
collapse(true)
);
// the hierarchy must be locked prior to update
doc.readLock();
hierarchy.lock();
try {
operation.update(newInfos, null, null);
} finally {
}
</pre>
The <code>update()</code> operation performs a diff, creates new folds, discards old ones, and updates the folds, which
prevailed.
<h3>Accessing folds</h3>
Instead of keeping a copy of created folds, the FoldManager may call <code>operation.foldIterator</code>. The iterator
will enumerate all folds, including (recursively) blocked ones.
<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>Answer:</b>
The cvs/editor/fold module is currently maintained
under fold_api branch of the editor module.
<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>Answer:</b>
The unit tests will be created to cover the functionality testing.
<p>
We are also considering to create randomized tests
that would construct artificial fold managers
and randomly insert/remove folds and do random modifications
to the file. This way we could make a stress test for the fold merging algorithms
present in FoldHierarchyTransaction (and FoldHierarchySpi).
</p>
<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>Answer:</b>
<p>
<p>
The sources for the module are in the
<a href="http://hg.netbeans.org/" shape="rect">NetBeans Mercurial repositories</a>.
</p>
</p>
</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>
<p>
Specific fold managers can have their own additional
dependencies (e.g. Java fold manager depends on Java Source Hierarchy etc.).
</p>
<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='MimeLookupAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.31
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='EditorSettingsAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.32
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='devel' name='EditorUtilitiesAPI'>
The module is needed for compilation.
The module is used during runtime.
</api>
</li>
--><!--<li><api type='import' group='java' category='official' name='LexerAPI'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.50
is required.
</api>
</li>
--><!--<li><api type='import' group='java' category='private' name='org.netbeans.modules.editor.settings.lib'>
The module is needed for compilation.
The module is used during runtime.
Specification version
1.39
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-MimeLookupAPI">MimeLookupAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.31
is required.
</li>
<li>
<a href="#java-EditorSettingsAPI">EditorSettingsAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.32
is required.
</li>
<li>
<a href="#java-EditorUtilitiesAPI">EditorUtilitiesAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
</li>
<li>
<a href="#java-LexerAPI">LexerAPI</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.50
is required.
</li>
<li>
<a href="#java-org.netbeans.modules.editor.settings.lib">org.netbeans.modules.editor.settings.lib</a>
-
The module is needed for compilation.
The module is used during runtime.
Specification version
1.39
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>
No other projects.
<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>
All platforms.
<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>
JDK1.4 and higher can be used.
<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 sufficient.
</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>
No additional files.
<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>
Anywhere.
<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>
Yes, only the API and SPI are public. The implementation is not public.
<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>Answer:</b>
Nothing.
</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>
Compaible with standards.
<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>
The CF presets are stored as part of editor settings.
<br>
We plan to introduce fold state persistence sometimes in the future
so the collapsed fold status would persist for individual files.
<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>Answer:</b>
<p>
XXX no answer for compat-deprecation
</p>
</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>
No.
<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>
No.
<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>
Module reads fold managers registered fold manager factories for the given mime-type
from the Editors/&lt;mime-type&gt;/FoldManager folder.
<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>Answer:</b>
<p>
XXX no answer for resources-preferences
</p>
</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>
No
<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>
No.
<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>
No.
<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>
The FoldHierarchy instance is physically stored as client property of the text component with key FoldHierarchy.class.
<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>Answer:</b>
<p>
XXX no answer for exec-ant-tasks
</p>
<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>
No.
<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>
No.
<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>Answer:</b>
No.
<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>Answer:</b>
No.
<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>Answer:</b>
FoldHierarchy needs to be locked exclusively prior manipulation; <code>FoldHierarchy.render(Runnable)</code> (or <code>FoldHierarchy.lock()</code>) can be used to lock the hierarchy for an exclusive use.
<br>
Locking of the hierarchy should be preceded by document locking that ensures document model stability.
<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>Answer:</b>
No.
<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>Answer:</b>
No.
</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 files read or written to the disk.
<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>
No D&amp;D.
<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>
No clipboard support.
</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>
No.
<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>
Number of methods/classes/javadocs in a java source file. Those things typically scales with size of the file.
<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 limits when assuming Integer.MAX_VALUE (for number of folds etc.) is not a practical limit.
<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>
A fold instance (e.g. DescriptionFold) should take about 192 bytes. There are typically tens to hundreds of folds in a typical java file.
<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 creation and updating of the folds for large files are potentially
long-running tasks.
<br>
The editor infrastructure can consult the fold hierarchy
for the fold presence (for the particular text component)
at any time (not strictly at the file opening time).
<br>
In general if there are no folding presets
(certain fold types collapsed at the file opening time)
the folds creation can be delayed after the document
is displayed initially.
<p>
Typically the physical fold creation
and updating is fast compared to the collecting of the underlying
information. For example collecting of the information
for java folds requires consulting of parser information
which may not be present at the time yet so this may result
in even a few seconds delay waiting for document parsing.
<br>
Therefore the fold managers are encouraged to prepare
the fold-related data (resulting into fold boundary positions)
in a separate thread and schedule the physical fold creation
and fold hierarchy updates (which are reasonably fast)
into EDT thread (due to consistency purposes as the EDT
controls the document switching in the editor text component).
<br>
The FoldManager class javadoc contains the guiding information
as well.
</p>
<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>Answer:</b>
Binary searches are used for all the operations. There should be no linear scans in critical parts of the Code Folding infrastructure.
</ul>
<!-- security -->
<!-- recovery -->
</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>&lt;api type="export"/&gt;</code>
to describe your general APIs.
If possible please provide
simple diagrams.
</hint>
</question>
-->
<!--
<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?
</hint>
</question>
-->
<!--
<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>
-->
<!--
<question id="arch-usecases" when="init">
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>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<question id="compat-standards" when="init">
Does the module implement or define any standards? Is the
implementation exact or does it deviate somehow?
</question>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<question id="dep-jrejdk" when="final">
Do you require the JDK or is the JRE enough?
</question>
-->
<!--
<question id="dep-nb" when="init">
What other NetBeans projects and modules does this one depend on?
<hint>
If you want, describe such projects as imported APIs 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" when="init">
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 preferred to use this approach when more modules may
depend on such third-party library.
</hint>
</question>
-->
<!--
<question id="dep-platform" when="init">
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" when="impl">
Do you deploy just module JAR file(s) or other files as well?
<hint>
If your module consists of just one module JAR file, just confirm that.
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>
-->
<!--
<question id="deploy-nbm" when="impl">
Can you deploy an NBM via the Update Center?
<hint>
If not why?
</hint>
</question>
-->
<!--
<question id="deploy-packages" when="init">
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/javadoc/OpenAPIs/org/openide/doc-files/upgrade.html#3.4-public-packages">
public packages
</a>). If you do not restrict access to your classes you are
making it too easy for other people to misuse your implementation
details, that is why you should have good reason for not
restricting package access.
</hint>
</question>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<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>
&lt;api type="export" group="property" name="id" category="private" url="http://..."&gt;
description of the property, where it is used, what it influence, etc.
&lt;/api&gt;
</pre>
</hint>
</question>
-->
<!--
<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>
-->
<!--
<question id="exec-threading" when="impl">
What threading models, if any, does your module adhere to?
<hint>
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>
-->
<!--
<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>
-->
<!--
<question id="format-dnd" when="impl">
Which protocols (if any) does your code understand during Drag &amp; 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>
-->
<!--
<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?
</question>
-->
<!--
<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>
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.
</hint>
</question>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<question id="perf-exit" when="final">
Does your module run any code on exit?
</question>
-->
<!--
<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>
-->
<!--
<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?
</question>
-->
<!--
<question id="perf-mem" when="final">
How much memory does your component consume? Estimate
with a relation to the number of windows, etc.
</question>
-->
<!--
<question id="perf-menus" when="final">
Does your module use dynamically updated context menus, or
context-sensitive actions with complicated enablement logic?
</question>
-->
<!--
<question id="perf-progress" when="final">
Does your module execute any long-running tasks?
<hint>Long running tasks should never block
AWT thread as it badly hurts the UI
<a href="http://performance.netbeans.org/responsiveness/issues.html">
responsiveness</a>.
Tasks like connecting over
network, computing huge amount of data, compilation
be done asynchronously (for example
using <code>RequestProcessor</code>), definitively it should
not block AWT thread.
</hint>
</question>
-->
<!--
<question id="perf-scale" when="init">
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?
<hint>
Please include some estimates, there are other more detailed
questions to answer in later phases of implementation.
</hint>
</question>
-->
<!--
<question id="perf-spi" when="init">
How the performance of the plugged in code will be enforced?
<hint>
If you allow foreign code to be plugged into your own module, how
do you enforce that it will behave correctly and quickly and will not
negatively influence the performance of your own module?
</hint>
</question>
-->
<!--
<question id="perf-startup" when="final">
Does your module run any code on startup?
</question>
-->
<!--
<question id="perf-wakeup" when="final">
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" when="final">
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 preferred
way that should be used. But of course there can be situations when
this is not suitable.
</hint>
</question>
-->
<!--
<question id="resources-layer" when="final">
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" when="final">
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" when="final">
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 classify according to
<a href="http://openide.netbeans.org/tutorial/api-design.html#categories">
common stability categories</a>.
</hint>
</question>
-->
<!--
<question id="security-grant" when="final">
Does your code grant addition rights to some code?
<hint>Avoid using a classloder that adds some extra
permissions to loaded code unless realy necessary.
Also note that your API implementation
can also expose unneeded permissions to enemy code by
AccessController.doPrilileged() calls.</hint>
</question>
-->
<!--
<question id="security-policy" when="final">
Does your functionality require standard policy file modification?
<hint>Your code may pass control to third party code not
coming from trusted domain. It covers code downloaded over
network or code coming from libraries that are not bundled
with NetBeans. Which permissions it needs to grant to which domain?</hint>
</question>
-->
<!--
<question id="arch-where" when="impl">
Where one can find sources for your module?
<hint>
Please provide link to the Hg web client at
http://hg.netbeans.org/
or just use tag defaultanswer generate='here'
</hint>
</question>
-->
<!--
<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>
-->
<!--
<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>
-->
<!--
<question id="resources-preferences" when="final">
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 ?
<hint>
You may use
&lt;api type="export" group="preferences"
name="preference node name" category="private"&gt;
description of individual keys, where it is used, what it
influences, whether the module reads/write it, etc.
&lt;/api&gt;
Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo.
Note that if you use NbPreferences this name will then be the same as the code name base of the module.
</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>