| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Lookup 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 Lookup API module</h1> |
| <ul> |
| <li> |
| <b>Author:</b> jtulach@netbeans.org</li> |
| <li> |
| <b>Answers as of:</b> 14-Sep-2018</li> |
| <li> |
| <b>Answers for questions version:</b> 1.25</li> |
| <li> |
| <b>Latest available version of questions:</b> 1.29</li> |
| </ul> |
| <strong> |
| WARNING: answering questions version 1.25 |
| 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>LookupAPI</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-LookupAPI"><a href="org/openide/util/lookup/doc-files/lookup-api.html"> |
| .../util/lookup/doc-files/lookup-api.html</a> |
| <p></p> |
| <p></p> |
| allows the discovery<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>LookupSPI</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Official">Official</a></td><td><a name="java-LookupSPI"><a href="org/openide/util/lookup/doc-files/lookup-spi.html"> |
| .../util/lookup/doc-files/lookup-spi.html</a> |
| <p></p> |
| <p></p> |
| simplifies creation and registration of own lookup objects<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>ProviderRegistrationMechanism</td><td>Imported</td><td><a href="http://wiki.netbeans.org/API_Stability#Standard">Standard</a></td><td><a name="java-ProviderRegistrationMechanism"><a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Provider%20Configuration%20File"> |
| ...//java.sun.com/j2se/1.3/docs/guide/jar/jar.html</a> |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>ProviderRegistrationRemoval</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java-ProviderRegistrationRemoval"><a href="../org-openide-util/org/openide/util/doc-files/api.html#service-lookup"> |
| .../org/openide/util/doc-files/api.html</a> |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>Lookups.metaInfServices</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java-Lookups.metaInfServices"><a href="org/openide/util/lookup/Lookups.html#metaInfServices-java.lang.ClassLoader-"> |
| .../org/openide/util/lookup/Lookups.html</a> |
| <p></p> |
| <p></p> |
| calls constructor of registered classes using reflection |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>Lookup.resetDefaultLookup</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Friend">Friend</a></td><td><a name="java-Lookup.resetDefaultLookup"> |
| <p></p> |
| There is a static private method <code>Lookup.resetDefaultLookup</code> that |
| is called by NbJUnit's <code>MockServices</code> to properly reset default |
| lookup and fire changes to all registred listeners. |
| <p></p> |
| </a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <a name="group-java.io.File"> |
| <h5>Group of java.io.File 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>FileLocation</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="java.io.File-FileLocation"> |
| <p></p> |
| the JAR file is located in platform cluster under <code>lib/org-openide-util-lookup.jar</code> |
| |
| <p></p> |
| </a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <a name="group-systemproperty"> |
| <h5>Group of systemproperty 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>org.openide.util.Lookup</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="systemproperty-org.openide.util.Lookup"> |
| <p></p> |
| checked by the initialization of the |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| and can |
| contain name of a class that extends <code>org.openide.util.Lookup</code> and |
| has public constructor, that should be instantiated and returned from |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| the class will be loaded by |
| <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Thread.html#getContextClassLoader--" shape="rect"> |
| Thread.currentThread().getContextClassLoader()</a> |
| classloader the first time <code>Lookup.getDefault</code> is invoked. |
| <p></p> |
| The property can also contain value <code>"-"</code> which means to completely |
| disable the lookup instantiation and return <a href="org/openide/util/Lookup.html#EMPTY" shape="rect">Lookup.EMPTY</a> |
| from <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a>. |
| <p></p> |
| If the property is unspecified, the default <code>MetaInfServicesLookup</code> |
| is constructed for <code>Thread.currentThread().getContextclassLoader()</code> |
| that implements the <a href="architecture-summary.html#answer-compat-standards" shape="rect">JDK's standard</a>. If, by |
| a chance an instance of |
| <a href="org/openide/util/Lookup.Provider.html" shape="rect">Lookup.Provider</a> |
| is found |
| in there, its lookup is returned as result. Otherwise the <code>MetaInfServicesLookup</code> |
| is the result of <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a>. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>org.openide.util.Lookup.paths</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="systemproperty-org.openide.util.Lookup.paths"> |
| <p></p> |
| Sometimes it may be useful for the Lookup to contains objects from |
| some system file system folder. This can be done with |
| <code>org.openide.util.Lookup.paths=Folder1:Folder2:Folder3</code>. |
| If this property is set prior to first call to |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a>, |
| it is split into pieces (separator is <code>':'</code>) and individual |
| parts are then used to construct <code>Lookups.forPath("Folder1")</code>, |
| etc. All these lookups then become part of the |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| one. This property works since version 7.24 |
| <p></p> |
| </a></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <p></p> |
| <a name="group-lookup"> |
| <h5>Group of lookup 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>LookupInitializationLookup</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="lookup-LookupInitializationLookup"><a href="#systemproperty-org.openide.util.Lookup">#systemproperty-org.openide.util.Lookup</a> |
| <p></p> |
| <p></p> |
| during |
| initialization of the <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| the <a href="org/openide/util/Lookup.Provider.html" shape="rect">Lookup.Provider</a> |
| is being searched<p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>LookupSharedClassObject</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="lookup-LookupSharedClassObject"> |
| <p></p> |
| singleton subclasses of <a href="../org-openide-util-ui/org/openide/util/SharedClassObject.html" shape="rect">SharedClassObject</a> |
| are searched for using Lookup. |
| <p></p> |
| </a></td> |
| </tr> |
| <tr class="tabler"> |
| <td>LookupClassLoader</td><td>Exported</td><td><a href="http://wiki.netbeans.org/API_Stability#Devel">Under Development</a></td><td><a name="lookup-LookupClassLoader"> |
| <p></p> |
| Nearly all resource looking functions and reflective code |
| uses <a href="http://download.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" shape="rect">ClassLoader</a> |
| obtained from <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| for loading system wide resources. |
| <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="jtulach@netbeans.org" module="Lookup API" question-version="1.25"> |
| |
| |
| <!-- |
| |
| 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> |
| |
| <p> |
| Described in the <a href="architecture-summary.html#answer-arch-overall" shape="rect">overall</a> answer. |
| </p> |
| |
| <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> |
| |
| <p> |
| This module defines the <a href="org/openide/util/Lookup.html" shape="rect"> |
| Lookup</a> which is the NetBeans way for dynamic registration |
| and lookup of |
| components in our modularized component system. It allows lookup and discovery |
| of features by description of their interfaces. The classes are devided |
| into two parts. The |
| <a href="#java-LookupAPI">LookupAPI</a> |
| - |
| allows the discovery and the |
| <a href="#java-LookupSPI">LookupSPI</a> |
| - |
| simplifies creation and registration of own lookup objects. |
| </p> |
| |
| <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> |
| <a href="https://leanpub.com/nbp4beginners" onclick="target='_blank'" shape="rect"> |
| <img alt="Cover of NetBeans Platform for Beginners book" height="70" src="http://wiki.apidesign.org/images/0/03/NetBeansPlatformForBeginners.jpg" style="float: right" width="60"> |
| </a> |
| |
| There is a great introduction to Lookup and its usage in its |
| <a href="org/openide/util/Lookup.html" shape="rect">javadoc</a>. |
| For details on this topic, |
| together with code samples, see chapter 4, |
| of <a href="https://leanpub.com/nbp4beginners" onclick="target='_blank'" shape="rect">NetBeans Platform for Beginners</a> |
| by Jason Wexbridge and Walter Nyland. |
| In addition to that here is |
| a list of frequently asked or interesting questions slowly expanding as |
| people ask them: |
| |
| <h3>Lookup faq:</h3> |
| |
| |
| <h4>How to specify that a service in Lookup should be available only on Windows?</h4> |
| |
| <em><b>Q:</b> |
| Most of the time I specify interfaces that I want to add to the Lookup class in the layer.xml file. |
| But, let's say I have a platform-specific interface (something on Windows only, for instance).</em> |
| |
| <p> |
| |
| <em> |
| How can I specify (in the xml, or programmatically) that this service should only be added to the Lookup if the platform is Windows? |
| </em>> |
| </p> |
| In general there are three ways to achieve this. |
| <ul> |
| |
| <li> |
| <p>It is possible to write a specific module and enable it only on windows. |
| See <a href="../org-openide-modules/org/openide/modules/doc-files/api.html#how-os-specific" shape="rect">os specific modules</a> documentation. |
| Then you can put a registration of your instance into your module's |
| <a href="../org-openide-util/org/openide/util/doc-files/api.html#service-lookup" shape="rect">META-INF/services</a> directory and it |
| will be available only on Windows.</p> |
| |
| </li> |
| |
| |
| <li> |
| <p>Another possibility that does not require new module, but which executes |
| a code on startup (which may have performance implications) is to use <code>methodvalue</code> |
| attribute. Register your instance in layer using <code>your-Object.instance</code> file |
| as described at |
| <a href="../org-openide-util/org/openide/util/doc-files/api.html#ido-methodvalue" shape="rect">services |
| </a> documentation and in your factory method either return the instance |
| your want or <code>null</code> depending on result of <a href="../org-openide-util/org/openide/util/BaseUtilities.html#isWindows--" shape="rect"> |
| Utilities.isWindows()</a> call.</p> |
| |
| </li> |
| |
| <li> |
| |
| <p> |
| In some cases, the interface for which you will register an implementation permits a |
| no-operation semantics. For example, <code>InstalledFileLocator.locate(...)</code> can |
| return a valid <code>File</code>, or null. You could always register an |
| <code>InstalledFileLocator</code> instance yet disable it on non-Windows platforms |
| (always returning null). |
| </p> |
| |
| </li> |
| |
| </ul> |
| |
| |
| |
| |
| <h4>How shall I write an extension point for my module?</h4> |
| |
| <p> |
| |
| <em><b>Q:</b> |
| I have more modules one of them providing the core functionality and |
| few more that wish to extend it. What is the right way to do it? |
| How does the Netbeans platform declare such extension point? |
| </em> |
| |
| </p> |
| |
| |
| <p> |
| |
| Start with declaring an extension interface in your |
| core module and put it into the module's <em>public packages</em>. Imagine |
| for example that the core module is in JAR file <code>org-my-netbeans-coremodule.jar</code> |
| and already contains in manifests line like |
| <code>OpenIDE-Module: org.my.netbeans.coremodule/1</code> and wants |
| to display various tips of the day provided by other modules and thus defines: |
| </p> |
| <pre xml:space="preserve"> |
| |
| <span class="java-keywords">package</span> <span class="java-identifier">org</span><span class="java-operators">.</span><span class="java-identifier">my</span><span class="java-operators">.</span><span class="java-identifier">netbeans</span><span class="java-operators">.</span><span class="java-identifier">coremodule</span><span class="java-operators">;</span> |
| |
| <span class="java-keywords">public</span> <span class="java-keywords">interface</span> <span class="java-identifier">TipsOfTheDayProvider</span> <span class="java-operators">{</span> |
| <span class="java-keywords">public</span> <span class="java-identifier">String</span> <span class="java-layer-method">provideTipOfTheDay</span> <span class="java-operators">(</span><span class="java-operators">)</span><span class="java-operators">;</span> |
| <span class="java-operators">}</span> |
| |
| </pre> |
| <p> |
| And in its manifest adds line |
| <code>OpenIDE-Module-Public-Packages: org.my.netbeans.coremodule.*</code> |
| to specify that this package contains exported API and shall be |
| accessible to other modules. |
| </p> |
| |
| <p> |
| When the core module is about to display the tip of the day it can ask |
| the system for all registered instances of the <code>TipsOfTheDayProvider</code>, |
| randomly select one of them: |
| </p> |
| <pre xml:space="preserve"> |
| |
| <span class="java-keywords">import</span> <span class="java-identifier">java</span><span class="java-operators">.</span><span class="java-identifier">util</span><span class="java-operators">.</span><span class="java-identifier">Collection</span><span class="java-operators">;</span> |
| <span class="java-keywords">import</span> <span class="java-identifier">java</span><span class="java-operators">.</span><span class="java-identifier">util</span><span class="java-operators">.</span><span class="java-identifier">Collections</span><span class="java-operators">;</span> |
| <span class="java-keywords">import</span> <span class="java-identifier">org</span><span class="java-operators">.</span><span class="java-identifier">openide</span><span class="java-operators">.</span><span class="java-identifier">util</span><span class="java-operators">.</span><span class="java-identifier">Lookup</span><span class="java-operators">;</span> |
| |
| <a href="org/openide/util/Lookup.Result.html" shape="rect"><span class="java-identifier">Lookup</span><span class="java-operators">.</span><span class="java-identifier">Result</span></a> <span class="java-identifier">result</span> <span class="java-operators">=</span> <a href="org/openide/util/Lookup.html" shape="rect"><span class="java-identifier">Lookup</span></a><span class="java-operators">.</span><span class="java-layer-method">getDefault</span> <span class="java-operators">(</span><span class="java-operators">)</span><span class="java-operators">.</span><span class="java-layer-method">lookup</span> <span class="java-operators">(</span><span class="java-keywords">new</span> <a href="org/openide/util/Lookup.Template.html" shape="rect"><span class="java-identifier">Lookup</span><span class="java-operators">.</span><span class="java-layer-method">Template</span></a> <span class="java-operators">(</span><span class="java-identifier">TipsOfTheDayProvider</span><span class="java-operators">.</span><span class="java-keywords">class</span><span class="java-operators">)</span><span class="java-operators">)</span><span class="java-operators">;</span> |
| <span class="java-identifier">Collection</span> <span class="java-identifier">c</span> <span class="java-operators">=</span> <span class="java-identifier">result</span><span class="java-operators">.</span><a href="org/openide/util/Lookup.Result.html#allInstances--" shape="rect"><span class="java-layer-method">allInstances</span></a> <span class="java-operators">(</span><span class="java-operators">)</span><span class="java-operators">;</span> |
| <span class="java-identifier">Collections</span><span class="java-operators">.</span><span class="java-layer-method">shuffle</span> <span class="java-operators">(</span><span class="java-identifier">c</span><span class="java-operators">)</span><span class="java-operators">;</span> |
| <span class="java-identifier">TipsOfTheDayProvider</span> <span class="java-identifier">selected</span> <span class="java-operators">=</span> <span class="java-operators">(</span><span class="java-identifier">TipsOfTheDayProvider</span><span class="java-operators">)</span><span class="java-identifier">c</span><span class="java-operators">.</span><span class="java-layer-method">iterator</span> <span class="java-operators">(</span><span class="java-operators">)</span><span class="java-operators">.</span><span class="java-layer-method">next</span> <span class="java-operators">(</span><span class="java-operators">)</span><span class="java-operators">;</span> |
| |
| </pre> |
| <p> |
| and then display the tip. Simple, trivial, just by the usage of |
| <a href="org/openide/util/Lookup.html" shape="rect">Lookup</a> interface once |
| creates a registry that other modules can enhance. But such enhancing |
| of course requires work on the other side. Each module that would like |
| to register its <code>TipsOfTheDayProvider</code> needs to depend on the |
| core module - add |
| <code>OpenIDE-Module-Module-Dependencies: org.my.netbeans.coremodule/1</code> |
| into its manifest and write a class with its own implementation of the |
| provider:</p> |
| <pre xml:space="preserve"> |
| |
| <span class="java-keywords">package</span> <span class="java-identifier">org</span><span class="java-operators">.</span><span class="java-identifier">my</span><span class="java-operators">.</span><span class="java-identifier">netbeans</span><span class="java-operators">.</span><span class="java-identifier">extramodule</span><span class="java-operators">;</span> |
| |
| <span class="java-keywords">class</span> <span class="java-identifier">ExtraTip</span> <span class="java-keywords">implements</span> <span class="java-identifier">TipsOfTheDayProvider</span> <span class="java-operators">{</span> |
| <span class="java-keywords">public</span> <span class="java-identifier">String</span> <span class="java-layer-method">provideTipOfTheDay</span> <span class="java-operators">(</span><span class="java-operators">)</span> <span class="java-operators">{</span> |
| <span class="java-keywords">return</span> <span class="java-string-literal">"Do you know that in order to write extension point you should use Lookup?"</span><span class="java-operators">;</span> |
| <span class="java-operators">}</span> |
| <span class="java-operators">}</span> |
| |
| </pre> |
| <p> |
| Then, the only necessary thing is to register such class by using the |
| J2SE standard <a href="#java-ProviderRegistrationMechanism">ProviderRegistrationMechanism</a> into plain text file |
| <code>META-INF/services/org.my.netbeans.coremodule.TipsOfTheDayProvider</code> |
| in the module JAR containing just one line: </p> |
| <pre xml:space="preserve"> |
| org.my.netbeans.extramodule.ExtraTip |
| </pre> |
| <p> |
| and your modules are now ready to communicate |
| using your own <em>extension point</em>. |
| </p> |
| |
| |
| |
| <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> |
| |
| <p> |
| The module has been around since 1997 and is continously being improved |
| from time to time. |
| </p> |
| |
| <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> |
| |
| <p> |
| There is a lot of unit tests in |
| <a href="http://hg.netbeans.org/main-golden/openide.util.lookup/test/unit/src/" shape="rect">version control</a> |
| system. |
| </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>N/A</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: |
| <ul></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>WARNING:</b> Question with id="<i>dep-non-nb</i>" has not been answered!<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> |
| |
| <p> |
| Platform independent. |
| </p> |
| |
| <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> |
| |
| <p> |
| Currently JRE 1.5 is needed. |
| </p> |
| |
| <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> |
| |
| <p> |
| JRE is enough. |
| </p> |
| |
| </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> |
| |
| <p> |
| |
| <a href="#java.io.File-FileLocation">FileLocation</a> |
| - |
| the JAR file is located in platform cluster under <code>lib/org-openide-util-lookup.jar</code> |
| . |
| </p> |
| |
| <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>WARNING:</b> Question with id="<i>deploy-nbm</i>" has not been answered!<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> |
| |
| <p> |
| Module is on real java classpath and as such it has to be in the shared directory. |
| </p> |
| |
| <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>WARNING:</b> Question with id="<i>deploy-packages</i>" has not been answered!<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> |
| |
| <p> |
| Nothing. |
| </p> |
| |
| </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>WARNING:</b> Question with id="<i>compat-i18n</i>" has not been answered!<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> |
| |
| <p> |
| The default lookup registration follows the JDK's |
| <a href="#java-ProviderRegistrationMechanism">ProviderRegistrationMechanism</a> |
| but enhances it to also support the |
| <a href="#java-ProviderRegistrationRemoval">ProviderRegistrationRemoval</a>. |
| </p> |
| |
| <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> |
| |
| <p> |
| This module has no settings. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <ul> |
| |
| <li> |
| <a href="#lookup-LookupInitializationLookup">LookupInitializationLookup</a> |
| - |
| during |
| initialization of the <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| the <a href="org/openide/util/Lookup.Provider.html" shape="rect">Lookup.Provider</a> |
| is being searched. |
| </li> |
| |
| |
| <li> |
| <a href="#lookup-LookupSharedClassObject">LookupSharedClassObject</a> |
| - |
| singleton subclasses of <a href="../org-openide-util-ui/org/openide/util/SharedClassObject.html" shape="rect">SharedClassObject</a> |
| are searched for using Lookup. |
| .</li> |
| |
| |
| <li> |
| <a href="#lookup-LookupClassLoader">LookupClassLoader</a> |
| - |
| Nearly all resource looking functions and reflective code |
| uses <a href="http://download.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" shape="rect">ClassLoader</a> |
| obtained from <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| for loading system wide resources. |
| .</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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| </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> |
| |
| <ul> |
| |
| <li> |
| |
| <a href="#systemproperty-org.openide.util.Lookup">org.openide.util.Lookup</a> |
| - |
| checked by the initialization of the |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| and can |
| contain name of a class that extends <code>org.openide.util.Lookup</code> and |
| has public constructor, that should be instantiated and returned from |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| the class will be loaded by |
| <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Thread.html#getContextClassLoader--" shape="rect"> |
| Thread.currentThread().getContextClassLoader()</a> |
| classloader the first time <code>Lookup.getDefault</code> is invoked. |
| <p></p> |
| The property can also contain value <code>"-"</code> which means to completely |
| disable the lookup instantiation and return <a href="org/openide/util/Lookup.html#EMPTY" shape="rect">Lookup.EMPTY</a> |
| from <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a>. |
| <p></p> |
| If the property is unspecified, the default <code>MetaInfServicesLookup</code> |
| is constructed for <code>Thread.currentThread().getContextclassLoader()</code> |
| that implements the <a href="architecture-summary.html#answer-compat-standards" shape="rect">JDK's standard</a>. If, by |
| a chance an instance of |
| <a href="org/openide/util/Lookup.Provider.html" shape="rect">Lookup.Provider</a> |
| is found |
| in there, its lookup is returned as result. Otherwise the <code>MetaInfServicesLookup</code> |
| is the result of <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a>. |
| |
| </li> |
| |
| |
| <li> |
| |
| <a href="#systemproperty-org.openide.util.Lookup.paths">org.openide.util.Lookup.paths</a> |
| - |
| Sometimes it may be useful for the Lookup to contains objects from |
| some system file system folder. This can be done with |
| <code>org.openide.util.Lookup.paths=Folder1:Folder2:Folder3</code>. |
| If this property is set prior to first call to |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a>, |
| it is split into pieces (separator is <code>':'</code>) and individual |
| parts are then used to construct <code>Lookups.forPath("Folder1")</code>, |
| etc. All these lookups then become part of the |
| <a href="org/openide/util/Lookup.html#getDefault--" shape="rect">Lookup.getDefault()</a> |
| one. This property works since version 7.24 |
| |
| </li> |
| |
| |
| </ul> |
| |
| <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>WARNING:</b> Question with id="<i>exec-component</i>" has not been answered!<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> |
| No. |
| </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> |
| |
| <p> |
| No, we do not create own classloader. |
| </p> |
| |
| <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> |
| |
| <p> |
| |
| <a href="#java-Lookups.metaInfServices">Lookups.metaInfServices</a> |
| - |
| calls constructor of registered classes using reflection |
| . |
| <a href="#java-Lookup.resetDefaultLookup">Lookup.resetDefaultLookup</a> |
| - |
| There is a static private method <code>Lookup.resetDefaultLookup</code> that |
| is called by NbJUnit's <code>MockServices</code> to properly reset default |
| lookup and fire changes to all registred listeners. |
| . |
| |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| No external processes executed. |
| </p> |
| |
| <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>Answer:</b> |
| |
| <p> |
| Everything is synchronous, except pluggable use of <code>java.util.concurrent.Executor</code> |
| that allows to make calls asynchronous. The default implementation only delivers |
| changes from <a href="org/openide/util/lookup/Lookups.html#metaInfServices-java.lang.ClassLoader-" shape="rect">metaInfServices</a> |
| lookup in asynchronous thread. |
| </p> |
| |
| <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> |
| |
| <p> |
| No security permissions manipulated. |
| </p> |
| |
| <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> |
| |
| <p> |
| No security permitions manipulated. |
| </p> |
| |
| </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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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 & Drop? |
| |
| </em></font> |
| <p></p> |
| <b>Answer:</b> |
| |
| <p> |
| The same as for clipboard. |
| </p> |
| |
| <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> |
| |
| <p> |
| Not used. |
| </p> |
| |
| </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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| Nothing. |
| </p> |
| |
| <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> |
| |
| <p> |
| Lookup code scales linearily. |
| </p> |
| |
| <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> |
| |
| <p> |
| The default implementation of the <code>MetaInfServicesLookup</code> just |
| keeps hashmap between queried classes and their implementations. The amount |
| of memory is linear to amount of registered classes, but of course we |
| are not counting the memory occupied by the instances which the lookup |
| creates, that can be arbitrary. |
| </p> |
| |
| <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> |
| |
| <p> |
| There are no big data structures. The amount of memory occupied by |
| instances of <a href="org/openide/util/lookup/AbstractLookup.html" shape="rect">AbstractLookup</a> |
| is measured by unit tests. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| No. |
| </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> |
| |
| <p> |
| No. |
| </p> |
| |
| <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> |
| |
| <p> |
| There are no menus. |
| </p> |
| |
| <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> |
| |
| <p> |
| No enforcing is done. |
| </p> |
| |
| </ul> |
| |
| |
| <!-- security --> |
| <!-- recovery --> |
| |
| |
| </api-questions> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <!-- |
| <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 and slow enablement logic? |
| <hint> |
| If you do a lot of tricks when adding actions to regular or context menus, you can significantly |
| slow down display of the menu, even when the user is not using your action. Pay attention to |
| actions you add to the main menu bar, and to context menus of foreign nodes or components. If |
| the action is conditionally enabled, or changes its display dynamically, you need to check the |
| impact on performance. In some cases it may be more appropriate to make a simple action that is |
| always enabled but does more detailed checks in a dialog if it is actually run. |
| </hint> |
| </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 additional rights to some other code? |
| <hint>Avoid using a class loader that adds extra |
| permissions to loaded code unless really necessary. |
| Also note that your API implementation |
| can also expose unneeded permissions to enemy code by |
| calling AccessController.doPrivileged().</hint> |
| </question> |
| --> |
| |
| |
| |
| |
| <!-- |
| <question id="security-policy" when="final"> |
| Does your functionality require modifications to the standard policy file? |
| <hint>Your code might pass control to third-party code not |
| coming from trusted domains. This could be code downloaded over the |
| network or code coming from libraries that are not bundled |
| with NetBeans. Which permissions need to be granted to which domains?</hint> |
| </question> |
| --> |
| |
| |
| |
| |
| |
| <!-- |
| <question id="arch-where" when="init"> |
| Where one can find sources for your module? |
| <hint> |
| Please provide link to the CVS web client at |
| http://www.netbeans.org/download/source_browse.html |
| or just use tag defaultanswer generate='here' |
| </hint> |
| </question> |
| --> |
| |
| |
| |
| |
| |
| <!-- |
| <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="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 |
| <api type="export" group="preferences" |
| name="preference node name" category="private"> |
| description of individual keys, where it is used, what it |
| influences, whether the module reads/write it, etc. |
| </api> |
| 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. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| </body> |
| </html> |
