Overview

# NetBeans Architecture Answers for java/project module

- Author: jglick@netbeans.org
- Answers as of: Dec 7, 2006
- Answers for questions version: 1.24
- Latest available version of questions: 1.26

WARNING: answering questions version 1.24 rather than the current 1.26.

## Interfaces table

##### Group of java interfaces

Interface Name | In/Out | Stability | Specified in What Document?
JavaProjectAPI | Exported | Official | The Java Project API is actually entirely SPI and supplies useful implementations of Java-related functionality specific to the project system.
ProjectClassPathExtender | Exported | Under Development | Implemented by `java/j2seproject` and asked for by `form`. Permits the Form Editor to add JavaBeans archives to the classpath of a J2SE project automatically.
ProjectClassPathSupport | Exported | Under Development | Support class containg helper method for creating `ClassPathImplementation` based on Ant properties.
Filesystems | Imported | Official | Various purposes.
Nodes | Imported | Official | Used for package view and perhaps for templates UI.
Datasystems | Imported | Official | Miscellaneous internal purposes.
Wizards | Imported | Official | Implementation of Java-specific template wizards.
ProjectAPI | Imported | Under Development | Various purposes.
JavaSupportAPIs | Imported | Official | Delegation of Java-specific queries.
AntModuleAPI | Imported | Under Development | `AntLogger` implementation to hyperlink stack traces.
JavaPlatformAPI | Imported | Under Development | Broken references correction GUI.
ProjectLibrariesAPI | Imported | Under Development | Broken references correction GUI.
SearchAPI | Imported | Under Development | Special searching semantics in the package view.
ProjectUIAPI | Imported | Under Development | Various purposes; at least, template GUI.
GeneralQueriesAPI | Imported | Under Development | API used for various purposes.

##### Group of layer interfaces

Interface Name | In/Out | Stability | Specified in What Document?
JavaModuleTemplates | Imported | Friend | Temporary home to add project-specific wizard iterators to Java language templates. Planned to be done differently in the future.

##### Group of property interfaces

Interface Name | In/Out | Stability | Specified in What Document?
org.netbeans.spi.java.project.support.ui.packageView.TRUNCATE_PACKAGE_NAMES | Exported | Private | If set to `true`, displays a truncated version of Java package names, usually in the Projects tab.
org.netbeans.spi.java.project.support.ui.packageView.USE_TREE_VIEW | Exported | Private | If set to `true`, displays Java packages in a tree rather than a flat list, usually in the Projects tab.

## General Information

Question (arch-what): What is this project good for?

Answer:

Provides support infrastructure for projects working with the Java language.

Question (arch-overall): Describe the overall architecture.

Answer:

- JavaProjectAPI -

  The Java Project API is actually entirely SPI and supplies useful implementations of Java-related functionality specific to the project system.

- ProjectClassPathExtender -

  Implemented by `java/j2seproject` and asked for by `form`. Permits the Form Editor to add JavaBeans archives to the classpath of a J2SE project automatically.

  ProjectClassPathSupport -

  Support class containg helper method for creating `ClassPathImplementation` based on Ant properties.

Question (arch-usecases): Describe the main use cases 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?

Answer:

Project type providers wishing to show Java packages in their logical views can use this SPI. Templates which are Java-centric can use it. Projects which wish to implement queries from the Java Support APIs can place implementations in their lookup and these will be delegated to automatically.

Question (arch-time): What are the time estimates of the work?

Answer:

Complete.

Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented?

Answer:

Non-GUI portions (including node-based UI) ought to be covered by unit tests. GUI portions may be covered by IDE-wide functional tests.

Question (arch-where): Where one can find sources for your module?

WARNING: Question with id="arch-where" has not been answered!

## Project and platform dependencies

Question (dep-nb): What other NetBeans projects and modules does this one depend on?

Answer:

1. Filesystems -

   Various purposes.

2. Nodes -

   Used for package view and perhaps for templates UI.

3. Datasystems -

   Miscellaneous internal purposes.

4. Wizards -

   Implementation of Java-specific template wizards.

5. ProjectAPI -

   Various purposes.

6. JavaSupportAPIs -

   Delegation of Java-specific queries.

7. AntModuleAPI -

   `AntLogger` implementation to hyperlink stack traces.

8. JavaPlatformAPI -

   Broken references correction GUI.

9. ProjectLibrariesAPI -

   Broken references correction GUI.

10. SearchAPI -

    Special searching semantics in the package view.

11. ProjectUIAPI -

    Various purposes; at least, template GUI.

12. GeneralQueriesAPI -

    API used for various purposes.

13. JavaModuleTemplates -

    Temporary home to add project-specific wizard iterators to Java language templates. Planned to be done differently in the future.

Question (dep-non-nb): What other projects outside NetBeans does this one depend on?

Answer:

None.

Question (dep-platform): On which platforms does your module run? Does it run in the same way on each?

Answer:

Any.

Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?

Answer:

1.4+.

Question (dep-jrejdk): Do you require the JDK or is the JRE enough?

Answer:

JRE.

## Deployment

Question (deploy-jar): Do you deploy just module JAR file(s) or other files as well?

Answer:

Just a JAR.

Question (deploy-nbm): Can you deploy an NBM via the Update Center?

Answer:

Yes.

Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere?

Answer:

Anywhere.

Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public?

Answer:

Only API and SPI packages are exported as public.

Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one?

Answer:

For normal usage:

       OpenIDE-Module-Module-Dependencies: org.netbeans.modules.java.project/1 > 1.8.22

## Compatibility with environment

Question (compat-i18n): Is your module correctly internationalized?

Answer:

Yes.

Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow?

Answer:

No.

Question (compat-version): 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?

Answer:

No settings.

## Access to resources

Question (resources-file): Does your module use `java.io.File` directly?

Answer:

In a few places as circumstances require.

Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components?

Answer:

Registers iterators for Java templates. Also registers context menu actions for Java source files. Registers a couple of options, and adds an action to the Projects tab to switch package display style.

Question (resources-read): Does your module read any resources from layers? For what purpose?

Answer:

No.

Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers?

Answer:

Registers iterators for Java templates.

## Lookup of components

Question (lookup-lookup): Does your module use `org.openide.util.Lookup` or any similar technology to find any components to communicate with? Which ones?

Answer:

Delegating query implementations search project lookups for their delegates. PackageViewChildren.PackageNode.setName() looks for one instance of org.netbeans.spi.java.project.support.ui.PackageRenameHandler.

Question (lookup-register): Do you register anything into lookup for other code to find?

Answer:

Delegating query implementations are registered to global lookup. The `AntLogger` used for stack trace hyperlinking is registered.

Question (lookup-remove): Do you remove entries of other modules from lookup?

Answer:

No.

## Execution Environment

Question (exec-property): Is execution of your code influenced by any environment or Java system (`System.getProperty`) property?

Answer:

- org.netbeans.spi.java.project.support.ui.packageView.TRUNCATE_PACKAGE_NAMES -

  If set to `true`, displays a truncated version of Java package names, usually in the Projects tab.

- org.netbeans.spi.java.project.support.ui.packageView.USE_TREE_VIEW -

  If set to `true`, displays Java packages in a tree rather than a flat list, usually in the Projects tab.

Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?

Answer:

No.

Question (exec-ant-tasks): Do you define or register any ant tasks that other can use?

WARNING: Question with id="exec-ant-tasks" has not been answered!

Question (exec-classloader): Does your code create its own class loader(s)?

Answer:

No.

Question (exec-reflection): Does your code use Java Reflection to execute other code?

Answer:

Adjusts the context actions for Java source files, since the Java module does not depend on project-specific APIs and there is no declarative registration for `DataNode` context menus.

Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection?

Answer:

No.

Question (exec-process): 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?

Answer:

No.

Question (exec-introspection): Does your module use any kind of runtime type information (`instanceof`, work with `java.lang.Class`, etc.)?

Answer:

No.

Question (exec-threading): What threading models, if any, does your module adhere to?

Answer:

EQ for the GUI-related things, otherwise whatever queries dictate.

Question (security-policy): Does your functionality require modifications to the standard policy file?

Answer:

No.

Question (security-grant): Does your code grant additional rights to some other code?

Answer:

No.

## Format of files and protocols

Question (format-types): 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?

Answer:

None.

Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop?

Answer:

None.

Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods on `java.awt.datatransfer.Transferable`?

Answer:

None. Behavior of package view with respect to the clipboard has not been fully specified.

## Performance and Scalability

Question (perf-startup): Does your module run any code on startup?

Answer:

Replaces actions for Java source file context menus.

Question (perf-exit): Does your module run any code on exit?

Answer:

No.

Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales?

Answer:

Number of subpackages for the package view (since they are all displayed in a list).

Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle?

Answer:

None known.

Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc.

Answer:

Should not be large. Not measured in case of package view.

Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)?

Answer:

No.

Question (perf-progress): Does your module execute any long-running tasks?

Answer:

The package view currently finds subpackages synchronously but this could probably be rewritten to run asynchronously.

Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas?

Answer:

No, only template wizard panels.

Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic?

Answer:

No.

Question (perf-spi): How the performance of the plugged in code will be enforced?

Answer:

No special provisions.

Built on December 7 2006. | Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.