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
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.
<!-- <question id="arch-overall" when="init"> Describe the overall architecture. <hint> What will be API for <a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi"> clients and what support API</a>? What parts will be pluggable? How will plug-ins be registered? Please use <code><api type="export"/></code> to describe your general APIs. If possible please provide simple diagrams. </hint> </question>
-->
<answer id="arch-overall">
The Refactoring API module provides UI and API framework for easy and uniform implementation of refactoring features.
The Refactoring module provides:
<ul>
<li>API, which allows clients to invoke refactorings programmatically.</li>
<li>Plug-in SPI that allows other clients to participate in existing refactorings. E.g. Java Refactoring module implements refactoring features for java files,
while J2EE module adds refactoring capability for deployment descriptors</li>
<li>API for definition of new Refactorings and pluging them into Refactoring framework</li>
</ul>
</answer>
<!-- <question id="arch-quality" when="init"> How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html">quality</a> of your code be tested and how are future regressions going to be prevented? <hint> What kind of testing do you want to use? How much functionality, in which areas, should be covered by the tests? </hint> </question>
-->
<answer id="arch-quality">
<p>
Refactoring module functionality will be covered by Refactoring Unit tests.
</p>
</answer>
<!-- <question id="arch-time" when="init"> What are the time estimates of the work? <hint> Please express your estimates of how long the design, implementation, stabilization are likely to last. How many people will be needed to implement this and what is the expected milestone by which the work should be ready? </hint> </question>
-->
<answer id="arch-time">
<p>
Target Milestone for this task is NetBeans 6.0Dev, M7
</p>
</answer>
<!-- <question id="arch-usecases" when="init"> <hint> Content of this answer will be displayed as part of page at http://www.netbeans.org/download/dev/javadoc/usecases.html You can use tags <usecase name="name> regular html description </usecase> and if you want to use an URL you can prefix if with @TOP@ to begin at the root of your javadoc </hint> Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase"> use cases</a> of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module? </question>
-->
<answer id="arch-usecases">
Refactoring module provides API for refactorings. The idea is that at least the most elementary set of refactorings should be
available via an API, so that the refactorings could be invoked programmatically. This is particulary useful when creating more
complex refactorings. These can then be composed from the primitive refactorings accessible via an API using delegation. As an example we can use
a simple rename refactoring. When renaming a class in a J2SE environment, simple rename refactoring (which renames all occurrences of
the class) is sufficient. However in a J2EE environment, renaming a class may require renaming of other classes to preserve the functionality
of the application (e.g. synchrinized renaming a home and remote interface for an EJB). This could be achieved by creating a more complex rename
refactoring composed of two simple rename refactorings (one for each class to be renamed).
<p/>
When analyzing flow of various refactorings, we have found out that the steps in the flow are very common for all
refactorings. The flow is as follows:
<ul>
<li>User selects an object (or set of objects) and chooses to invoke a particular refactoring on it.</li>
<li>Refactoring pre-conditions are checked - whether a given refactoring can be invoked on a given object (or set of objects) or not. User needs to be
presented with errors (if any). The errors can be fatal or non-fatal. If an error is fatal, it means the refactoring cannot be performed, if it is not
fatal, user should be notified of the problem but still be able to proceed with the refactoring.</li>
<li>User sets parameters of the refactoring - each refactoring has some input parameters (e.g. new name for an element in case of Rename refactoring).
These parameters need to be set by the client.</li>
<li>Entered values of refactoring parameters are checked - errors (if any) are presented to the user.</li>
<li>Refactoring collects all changes that need to be performed and presents them to the user.</li>
<li>User can choose to not perform a particular set of proposed changes.</li>
<li>Refactoring is performed - all the changes confirmed by user are made to the source code.</li>
</ul>
To make the implementation of various refactorings consistent, the refactoring module provides an API and UI framework that allows these refactorings to be plugged in. This
framework enforces the above flow. Using this framework (set of SPI and API) the refactoring implementor can focus purely on the things specific to that particular refactoring
(specific pre-conditions checks, parameters checks, implementation of changes, etc.) and leave the
functionality that is common for all refactorings (implementation of the flow) up to the framework.
<p/>
It is quite common that some modules need to be able to affect the behavior of a refactoring. There are 4 typical use-cases when this is desirable:
<ol>
<li>A module wants to implement refactoring features for their own elements. For instance Java Refactoring module wants to implement Refactoring for Java elements.</li>
<li>A module wants to participate in existing refactoring. E.g. refactoring of java files requires refactoring of non-java files in J2EE area. When a code is refactored, these non-java files need to be refactored too.
We can mention JSP files or deployment descriptors as an example.</li>
<li>A module introduces some hidden relationships between several elements. E.g. a single logical EJB consists of several physical classes. When one of these classes are refactored,
the other classes need to be refactored as well.</li>
<li>A module generates some derived code into the guarded blocks. In such case it is desirable that the provider of the guarded block refactors the guarded code, since
the refactoring module itself has no knowledge of where the guarded code comes from.</li>
</ol>
The refactoring module provides hooks for other modules - an SPI that allows other modules to participate in refactorings. The modules can participate on all refactoring
phases from "preCheck" (checking preconditions), through "checkParameters" (checking validity of refactoring parameters) to "prepare" (collecting changes).
Use-cases number 1), 2) and 3) are covered by the same SPI (interfaces RefactoringPluginFactory and RefactoringPlugin). The forth use-case (guarded blocks) are covered by
a separate set of interfaces, since for this use-case the module does not need to participate in all refactoring phases. The refactoring framework itself automatically detects
that a given change points to a code in guarded blocks and requests all registered guarded block providers to handle that situation.
<p/>
The rest of this section provides simple orientational examples of API/SPI usage.
<p/>
<b>Refactoring API</b> can be used for programmatical invocation of refactorings and for pluging ui for these refactorings in.
<p><i><b>Refactoring API Example:</b></i></p>
<i>Intention:</i> Programatically rename java file<code>com/company/Test.java</code> to <code>com/company/RenamedTest.java</code> and update references.
<pre>
FileObject fo = ...com/company/Test.java...
RefactoringSession renameSession = RefactoringSession.create("Rename Class");
refactoring = new RenameRefactoring(fo);
Problem pre = refactoring.preCheck();
if (pre!=null && pre.isFatal()) {
//fatal problem in precheck
return;
}
refactoring.setNewName("RenamedTest");
Problem p = refactoring.prepare(renameSession);
if (p!=null && p.isFatal()) {
//fatal problem in precheck
return;
}
<p>
<b>Refactoring SPI</b> permit other modules to plug into existing refactorings and allow them to participate.
Client of SPI must implement factory class <code>RefactoringPluginFactory</code> and register this class into Lookup.
</p>
<i><b>Refactoring SPI Example 1:</b></i>
<p>
<i>Intention:</i> Create a plugin for RenameRefactoring, which will participate in existing refactoring (let say in java refactoring)
and renames references in XML files.
</p>
<pre>
//implementation of factory class public class J2EERefactoringFactory implements RefactoringPluginFactory {
public RefactoringPlugin createInstance(AbstractRefactoring refactoring) {
if (refactoring instanceof RenameRefactoring) {
//return our custom instance for RenameRefactoring
if (wantToParticipate(refactoring.getRefactoredObject())
return new J2EERenameRefactoringPlugin((RenameRefactoring) refactoring);
}
if (refactoring instanceof ... {
...
}
return null;
}
}
</pre>
It is necessary to register <code>J2EERefactoringFactory</code> in the lookup:
<pre>
META-INF/services/org.netbeans.modules.refactoring.spi.RefactoringPluginFactory
</pre>
<p>
and implement RefactoringPlugin interface:
</p>
<pre>
//implementation of RefactoringPlugin public class J2EERenameRefactoringPlugin implements RefactoringPlugin {
private RenameRefactoring refactoring;
public J2EERenameRefactoringPlugin(RenameRefactoring refactoring) {
this.refactoring = refactoring;
}
public Problem preCheck() {
...
}
public Problem checkParameters() {
...
}
public Problem fastCheckParameters() {
...
}
public void cancelRequest() {
...
}
public Problem prepare(RefactoringElementsBag refactoringElements) {
RenameRefactoring renameRefactor = ((RenameRefactoring)refactoring);
Object element = renameRefactor.getRefactoredObject();
if (...) {
...
//lets add our RefactoringElements for usages found in XML files
refactoringElements.add(refactoring, new XMLRenameRefactoringElement());
}
return null;
}
public class XMLRenameRefactoringElement implements RefactoringElementImplementation {
public void performChange() {
//do change
}
}
</pre>
<i><b>Refactoring SPI Example 2:</b></i>
<i>Intention:</i> Create a module, which will add Rename... to html files
First you must create your ActionsImplementationProvider:
<pre> public class MyProvider extends ActionsImplementationProvider {
public boolean canRename(Lookup lookup) {
Node[] nodes = lookup.lookupAll(Node.class);
if (..one node selected and the node belongs to html...)
return true;
else
return fals;
}
public void doRename(Lookup selectedNodes) {
Node[] nodes = lookup.lookupAll(Node.class);
final FileObject fo = getFileFromNode(nodes[0]);
return new Runnable() { public void run() {
UI.openRefactoringUI(new RenameRefactoringUI(fo);
}
}
}
}
</pre>
And of course your own RefactoringPlugin and RefactoringPluginFactory see
<i><b>Refactoring SPI Example 1</b></i> and
<i><b>Refactoring SPI Example 2</b></i>
<br></br>
<i><b>Refactoring SPI Example 3</b></i>
Module wants to implement it's own refactoring preview tree:
Register your own TreeElementFactoryImplementation into META-INF/services
if you want to build your own RefactoringPreview tree.
For instance Java Refactoring understand Java - specific objects e.g.
Projects, Groups, Methods etc.
<pre> public TreeElement getTreeElement(Object o) {
.
.
if (o instanceof SourceGroup) {
return new SourceGroupTreeElement((SourceGroup)o);
} else if (o instanceof SomethingFromJava) {
return new SomethingFromJavaTreeElement((SomethingFromJava) o);
}
</pre>
TreeElement is then displayed in refactoring preview panel.
<br></br>
<br></br>
<br></br>Other usecases are docummented in javadoc.
<ul>
<li>Module wants to add common Refactoring Action into popup. <br></br>
See <a href="@TOP@/org/netbeans/modules/refactoring/api/ui/RefactoringActionsFactory.html">RefactoringActionsFactory</a>
</li>
<li> http://wiki.netbeans.org/wiki/view/RefactoringFAQ
</li>
</ul>
</answer>
<!-- <question id="arch-what" when="init"> What is this project good for? <hint> Please provide here a few lines describing the project, what problem it should solve, provide links to documentation, specifications, etc. </hint> </question>
-->
<answer id="arch-what">
<p>
Refactoring module allows developer to do high level code transformations aka refactorings.
</p>
</answer>
<!-- <question id="compat-standards" when="init"> Does the module implement or define any standards? Is the implementation exact or does it deviate somehow? </question>
-->
<answer id="compat-standards">
<p>
Refactoring module exposes <api name="RefactoringAPI" category="devel"type="export" group="java"/> and <api name="RefactoringSPI" category="devel"type="export" group="java"/>
</p>
</answer>
<!-- <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><api name="identification" type="import or export" category="stable" url="where is the description" /></code> </hint> </question>
-->
<answer id="dep-nb">
<defaultanswer generate="none"/>
<ul>
<li><api name="FilesystemsAPI"type="import"url="@org-openide-filesystems@/org/openide/filesystems/doc-files/api.html" category="official" group="java" /></li>
<li><api name="LookupAPI"type="import"url="@org-openide-util@/org/openide/util/doc-files/api.html#lookup" category="official" group="java" /></li>
<li><api name="UtilitiesAPI"type="import"url="@org-openide-util@/org/openide/util/doc-files/api.html" category="official" group="java" /></li>
<li><api name="NodesAPI" group="java"type="import" category="official"url="@org-openide-nodes@/overview-summary.html" /></li>
<li><api name="WindowSystemAPI" group="java"type="import" category="official"url="@org-openide-windows@/overview-summary.html"/></li>
<li><api group="java" name="ProjectAPI"type="import" category="devel"> </api> </li>
<li><api group="java" name="TextAPI"type="import" category="official"> </api> </li>
<li><api name="ProjectAPI"type="import" category="official" group="java">Project API</api></li>
<li><api name="DialogsAPI"type="import" category="official" group="java">Dialogs API</api></li>
<li><api name="ActionsAPI"type="import" category="official" group="java">Actions API</api></li>
<li><api name="ProgressAPI"type="import" category="official" group="java">Progress API</api></li>
<li><api name="UIUtilitiesAPI"type="import" category="official" group="java">UI Utilities API</api></li>
<li><api name="DiffAPI"type="import" category="official" group="java">Diff API</api></li>
<li><api name="JavaHelp"type="import" category="official" group="java">JavaHelp</api></li>
<li><api name="GuardedSections"type="import" category="official" group="java">Guarded Sections</api></li>
<li><api name="GeneralQueriesAPI"type="import" category="official" group="java">General Queries API</api></li>
</ul>
AbstractRefactoring and it's sublcasses understands following types in its Lookup
<ul>
<li>
<api name="FilesystemsAPI"type="import"url="@org-openide-filesystems@/org/openide/filesystems/doc-files/api.html" category="official" group="java">FileObject</api>
</li>
<li>
<api name="JavaSourceAPI"type="import" group="property" category="devel">TreePathHandle</api>
</li>
</ul>
</answer>
<!-- <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>
-->
<answer id="dep-non-nb">
<p>
None.
</p>
</answer>
<!-- <question id="dep-platform" when="init"> On which platforms does your module run? Does it run in the same way on each? <hint> If your module is using JNI or deals with special differences of OSes like filesystems, etc. please describe here what they are. </hint> </question>
-->
<answer id="dep-platform">
<p>
There are no known dependencies on any platform.
</p>
</answer>
<!-- <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>
-->
<answer id="deploy-packages">
The only public packages are
<ul>
<li>org.netbeans.modules.refactoring.api</li>
<li>org.netbeans.modules.refactoring.api.ui</li>
<li>org.netbeans.modules.refactoring.spi</li>
<li>org.netbeans.modules.refactoring.spi.ui</li>
</ul>
</answer>
<!-- <question id="lookup-lookup" when="init"> Does your module use <code>org.openide.util.Lookup</code> or any similar technology to find any components to communicate with? Which ones? <hint> 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. For that use <api group=&lookup& /> tag. </hint> </question>
-->
<answer id="lookup-lookup">
Yes. We search for:
<ul>
<li><api group="lookup" name="org.netbeans.api.javahelp.Help"type="import" category="official"/></li>
<li>all instances of <api group="lookup" name="org.netbeans.modules.refactoring.spi.RefactoringPluginFactory"type="export" category="devel" /></li>
<li>all instances of <api group="lookup" name="org.netbeans.modules.refactoring.spi.GuardedBlockHandlerFactory"type="export" category="devel" /></li>
<li>an instance of <api group="lookup" name="org.netbeans.modules.refactoring.spi.ReadOnlyFilesHandler"type="export" category="devel" /></li>
<li>all instances of <api group="lookup" name="org.netbeans.modules.refactoring.spi.ui.ActionsImplementationProvider"type="export" category="devel" /></li>
<li>all instances of <api group="lookup" name="org.netbeans.modules.refactoring.spi.ui.TreeElementFactoryImplementation"type="export" category="devel" /></li>
</ul>
</answer>
<!-- <question id="perf-limit" when="init"> Are there any hard-coded or practical limits in the number or size of elements your code can handle? </question>
-->
<answer id="perf-limit">
<p>
No.
</p>
</answer>
<!-- <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>
-->
<answer id="perf-scale">
<p>
Not known.
</p>
</answer>
<!-- <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>
-->
<answer id="perf-spi">
<p>
SPI will be well documented.
</p>
</answer>
<!-- <question id="compat-version" when="impl"> Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version? <hint> Very helpful for reading settings is to store version number there, so future versions can decide whether how to read/convert the settings and older versions can ignore the new ones. </hint> </question>
-->
<answer id="compat-version">
<p>
Refactoring module does not load or save any settings.
</p>
</answer>
<!-- <question id="dep-jre" when="final"> Which version of JRE do you need (1.2, 1.3, 1.4, etc.)? <hint> It is expected that if your module runs on 1.x that it will run on 1.x+1 if no, state that please. Also describe here cases where you run different code on different versions of JRE and why. </hint> </question>
-->
<answer id="dep-jre">
<p>
Refactoring module doesn't have any special requirements on JDK version. It runs on JDK 1.5+
</p>
</answer>
<!-- <question id="dep-jrejdk" when="final"> Do you require the JDK or is the JRE enough? </question>
-->
<answer id="dep-jrejdk">
<p>
JRE is enough.
</p>
</answer>
<!-- <question id="deploy-jar" when="impl"> Do you deploy just module JAR file(s) or other files as well? <hint> Usually a module consist of one JAR file (perhaps with Class-Path extensions) and also a configuration file that enables it. If you have any other files, use <api group="java.io.File" name="yourname" type="export" category="friend">...</api> to define the location, name and stability of your files (of course changing "yourname" and "friend" to suit your needs). If it uses more than one JAR, describe where they are located, how they refer to each other. If it consist of module JAR(s) and other files, please describe what is their purpose, why other files are necessary. Please make sure that installation/uninstallation leaves the system in state as it was before installation. </hint> </question>
-->
<answer id="deploy-jar">
<p>
We deploy only one file: module JAR.
</p>
</answer>
<!-- <question id="deploy-nbm" when="impl"> Can you deploy an NBM via the Update Center? <hint> If not why? </hint> </question>
-->
<answer id="deploy-nbm">
<p>
Yes
</p>
</answer>
<!-- <question id="deploy-shared" when="final"> Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere? <hint> Installation location shall not matter, if it does explain why. Consider also whether <code>InstalledFileLocator</code> can help. </hint> </question>
-->
<answer id="deploy-shared">
<p>
The module can be installed anywhere.
</p>
</answer>
<!-- <question id="exec-classloader" when="impl"> Does your code create its own class loader(s)? <hint> A bit unusual. Please explain why and what for. </hint> </question>
-->
<answer id="exec-classloader">
<p>
No.
</p>
</answer>
<!-- <question id="exec-component" when="impl"> Is execution of your code influenced by any (string) property of any of your components? <hint> Often <code>JComponent.getClientProperty</code>, <code>Action.getValue</code> or <code>PropertyDescriptor.getValue</code>, etc. are used to influence a behavior of some code. This of course forms an interface that should be documented. Also if one depends on some interface that an object implements (<code>component instanceof Runnable</code>) that forms an API as well. </hint> </question>
-->
<answer id="exec-component">
<p>
<api name="ActionMapKeys" category="stable" group="property"type="import" >
the usages window defines <q>jumpNext</q> and <q>jumpPrev</q> action
handlers in its <code>ActionMap</code>.
</api>
</p>
</answer>
<!-- <question id="exec-introspection" when="impl"> Does your module use any kind of runtime type information (<code>instanceof</code>, work with <code>java.lang.Class</code>, etc.)? <hint> Check for cases when you have an object of type A and you also expect it to (possibly) be of type B and do some special action. That should be documented. The same applies on operations in meta-level (Class.isInstance(...), Class.isAssignableFrom(...), etc.). </hint> </question>
-->
<answer id="exec-introspection">
<p>
Yes. Introspection is important part of Refactoring API.
Refactoring API itself works in many cases just with "Objects" not knowing the type of object.
API users are required to implement Refactorings only for objects, which are known to them.
</p>
</answer>
<!-- <question id="exec-privateaccess" when="final"> Are you aware of any other parts of the system calling some of your methods by reflection? <hint> If so, describe the "contract" as an API. Likely private or friend one, but still API and consider rewrite of it. </hint> </question>
-->
<answer id="exec-privateaccess">
<p>
No
</p>
</answer> <!-- <question id="exec-process" when="impl"> Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code? <hint> If you feed an input, parse the output please declare that as an API. </hint> </question>
-->
<answer id="exec-process">
<p>
No
</p>
</answer>
<!-- <question id="exec-property" when="impl"> Is execution of your code influenced by any environment or Java system (<code>System.getProperty</code>) property? <hint> If there is a property that can change the behavior of your code, somebody will likely use it. You should describe what it does and the <a href="http://openide.netbeans.org/tutorial/api-design.html#life" shape="rect">stability category</a> of this API. You may use <pre xml:space="preserve"> <api type="export" group="property" name="id" category="private" url="http://..."> description of the property, where it is used, what it influence, etc. </api> </pre> </hint> </question>
-->
<answer id="exec-property">
<p>
No
</p>
</answer>
<!-- <question id="exec-reflection" when="impl"> Does your code use Java Reflection to execute other code? <hint> This usually indicates a missing or insufficient API in the other part of the system. If the other side is not aware of your dependency this contract can be easily broken. </hint> </question>
-->
<answer id="exec-reflection">
<p>
No
</p>
</answer>
<!-- <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" shape="rect">Threading Recommendations</a> (in progress) </hint> </question>
-->
<answer id="exec-threading">
<p>
Refactoring adhere threading model of java/source module.
</p>
</answer>
<!-- <question id="format-clipboard" when="impl"> Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on <code>java.awt.datatransfer.Transferable</code>? <hint> Often Node's deal with clipboard by usage of <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>. Check your code for overriding these methods. </hint> </question>
-->
<answer id="format-clipboard">
<p>
We register our own ClipboardConvertor and we wrap each refactorable Node Transferables with Refactoring Transferables
in order to handle move/cut/copy actions as refactoring actions.
</p>
</answer>
<!-- <question id="format-dnd" when="impl"> Which protocols (if any) does your code understand during Drag & Drop? <hint> Often Node's deal with clipboard by usage of <code>Node.drag, Node.getDropType</code>. Check your code for overriding these methods. Btw. if they are not overridden, they by default delegate to <code>Node.clipboardCopy, Node.clipboardCut and Node.pasteTypes</code>. </hint> </question>
-->
<answer id="format-dnd">
<p>
We don't override Node.drag. We have our own ClipboardConvertor. See above.
</p>
</answer>
<!-- <question id="format-types" when="impl"> Which protocols and file formats (if any) does your module read or write on disk, or transmit or receive over the network? </question>
-->
<answer id="format-types">
<p>
N/A
</p>
</answer>
<!-- <question id="lookup-register" when="final"> Do you register anything into lookup for other code to find? <hint> Do you register using layer file or using <code>META-INF/services</code>? Who is supposed to find your component? </hint> </question>
-->
<answer id="lookup-register">
<p>
We register classes into META-INF/services:
<code>
org.openide.loaders.FolderRenameHandle to handle rename action on folders
org.openide.util.actions.ExtendedDelete to handle delete on multiple nodes
org.openide.util.datatransfer.ExClipboard$Convertor to register ClipboardConvertor
</code>
</p>
</answer>
<!-- <question id="lookup-remove" when="final"> Do you remove entries of other modules from lookup? <hint> Why? Of course, that is possible, but it can be dangerous. Is the module your are masking resource from aware of what you are doing? </hint> </question>
-->
<answer id="lookup-remove">
<p>
No
</p>
</answer>
<!-- <question id="perf-exit" when="final"> Does your module run any code on exit? </question>
-->
<answer id="perf-exit">
<p>
No
</p>
</answer>
<!-- <question id="perf-huge_dialogs" when="final"> Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas? </question>
-->
<answer id="perf-huge_dialogs">
<p>
Yes. RefactoringPanel (Output window with tree of found usages can contain big number of found references).
</p>
</answer>
<!-- <question id="perf-mem" when="final"> How much memory does your component consume? Estimate with a relation to the number of windows, etc. </question>
-->
<answer id="perf-mem">
<p>
I don't know.
</p>
</answer>
<!-- <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>
-->
<answer id="perf-menus">
<p>
No
</p>
</answer>
<!-- <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" shape="rect"> 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>
-->
<answer id="perf-progress">
<p>
Yes. Collecting usages is long-running task. It is properly indicated by progress bar and does not lock AWT thread.
</p>
</answer>
<!-- <question id="perf-startup" when="final"> Does your module run any code on startup? </question>
-->
<answer id="perf-startup">
<p>
No.
</p>
</answer>
<!-- <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>
-->
<answer id="perf-wakeup">
<p>
No
</p>
</answer>
<!-- <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>
-->
<answer id="resources-file">
<p>
No
</p>
</answer>
<!-- <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>
-->
<answer id="resources-layer">
Refactoring module registers following items:
<ul>
<li>Menu items into <api name="Menu" group="layer"type="import" category="official"/> folder</li>
<li>Shrtcuts into <api name="Shortcuts" group="layer"type="import" category="official"/> folder</li>
<li>Actions into <api name="Actions" group="layer"type="import" category="official"/> folder</li>
<li>DataObject's Actions (Loaders/folder/any/Actions
<li>New file Services/org-netbeans-modules-refactoring/options which is used for storing settings of checkbox 'Preview All' and 'Search In Comments'</li>
</ul>
</answer>
<!-- <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>
-->
<answer id="resources-mask">
<p>
We hide regular RenameAction (in Loaders/folder/any/Actions)
</p>
</answer>
<!-- <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" shape="rect"> common stability categories</a>. </hint> </question>
-->
<answer id="resources-read">
<p>
We read contents of Menu/Refactoring in order to provide the same popup menu.
</p>
</answer>
<!-- <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>
-->
<answer id="security-grant">
<p>
No
</p>
</answer>
<!-- <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>
-->
<answer id="security-policy">
<p>
No
</p>
</answer>
<!-- <question id="exec-ant-tasks" when="impl"> Do you define or register any ant tasks that other can use? <hint> If you provide an ant task that users can use, you need to be very careful about its syntax and behaviour, as it most likely forms an API for end users and as there is a lot of end users, their reaction when such API gets broken can be pretty strong. </hint> </question>
-->
<answer id="exec-ant-tasks">
<p>
XXX no answer for exec-ant-tasks
</p>
</answer>
<!-- <question id="arch-where" when="impl"> Where one can find sources for your module? <hint> Please provide link to the CVS web client at http://www.netbeans.org/download/source_browse.html or just use tag defaultanswer generate='here' </hint> </question>
-->
<answer id="arch-where">
<defaultanswer generate='here' />
</answer>
<!-- <question id="compat-deprecation" when="init"> How the introduction of your project influences functionality provided by previous version of the product? <hint> If you are planning to deprecate/remove/change any existing APIs, list them here accompanied with the reason explaining why you are doing so. </hint> </question>
-->
<answer id="compat-deprecation">
<p>
XXX no answer for compat-deprecation
</p>
</answer>
<!-- <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>
-->
<answer id="resources-preferences">
<p>
XXX no answer for resources-preferences
</p>
</answer>
</api-answers>
¤ Dauer der Verarbeitung: 0.24 Sekunden
(vorverarbeitet)
¤
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.
