NetBeans Architecture Answers for Java Common Project API module

General Information

Question (arch-what): What is this project good for?
Answer: This module has not provided an architectural description, sorry.
Question (arch-overall): Describe the overall architecture.
Answer:No answer
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:No answer
Question (arch-time): What are the time estimates of the work?
Answer:No answer
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented?
Answer:No answer
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:No answer

The default answer to this question is:


These modules are required in project.xml:

• AntLogger - The module is needed for compilation. The module is used during runtime. Specification version 3.34 is required.
• CommonAnnotationsAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.6 is required.
• JavaSupportAPIs - The module is needed for compilation. The module is used during runtime. Specification version 1.47 is required.
• ClassPathAPIs - The module is needed for compilation. The module is used during runtime. Specification version 1.0 is required.
• Progress - The module is needed for compilation. The module is used during runtime. Specification version 1.17 is required.
• org.netbeans.libs.javacapi - The module is needed for compilation. The module is used during runtime. Specification version 0.5 is required.
• ExternalExecutionAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.30 is required.
• JavaPlatformAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.10 is required.
• JavaProjectAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.46 is required.
• JavaSourceAPI - The module is needed for compilation. The module is used during runtime. Specification version 0.67 is required.
• java.sourceui - The module is needed for compilation. The module is used during runtime. Specification version 1.1 is required.
• AntProjectAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.47 is required.
• ProjectLibrariesAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.16 is required.
• ProjectAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.43 is required.
• ProjectUIAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.71 is required.
• GeneralQueriesAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.11 is required.
• ActionsAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• org.openide.awt - The module is needed for compilation. The module is used during runtime. Specification version 6.12 is required.
• DialogsAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.6 is required.
• ExecutionAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.2 is required.
• FilesystemsAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.57 is required.
• LoadersAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.9 is required.
• ModulesAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.4 is required.
• NodesAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.3 is required.
• UtilitiesAPI - The module is needed for compilation. The module is used during runtime. Specification version 8.25 is required.
• LookupAPI - The module is needed for compilation. The module is used during runtime. Specification version 8.0 is required.
• WindowSystemAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:No answer
Question (dep-platform): On which platforms does your module run? Does it run in the same way on each?
Answer:No answer
Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)?
Answer:No answer
Question (dep-jrejdk): Do you require the JDK or is the JRE enough?
Answer:No answer

Deployment

Question (deploy-jar): Do you deploy just module JAR file(s) or other files as well?
Answer:No answer
Question (deploy-nbm): Can you deploy an NBM via the Update Center?
Answer:No answer
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:No answer
Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public?
Answer:No answer
Question (deploy-dependencies): 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)?
Answer:No answer

Compatibility with environment

Question (compat-i18n): Is your module correctly internationalized?
Answer:No answer
Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow?
Answer:No answer
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 answer
Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
WARNING: Question with id="compat-deprecation" has not been answered!

Access to resources

Question (resources-file): Does your module use java.io.File directly?
Answer:No answer
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:No answer
Question (resources-read): Does your module read any resources from layers? For what purpose?
Answer:No answer
Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers?
Answer:No answer
Question (resources-preferences): 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 ?
WARNING: Question with id="resources-preferences" has not been answered!

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:No answer
Question (lookup-register): Do you register anything into lookup for other code to find?
Answer:No answer
Question (lookup-remove): Do you remove entries of other modules from lookup?
Answer:No answer

Execution Environment

Question (exec-property): Is execution of your code influenced by any environment or Java system (System.getProperty) property? On a similar note, is there something interesting that you pass to java.util.logging.Logger? Or do you observe what others log?
Answer:No answer
Question (exec-component): Is execution of your code influenced by any (string) property of any of your components?
Answer:No answer
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 answer
Question (exec-reflection): Does your code use Java Reflection to execute other code?
Answer:No answer
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection?
Answer:No answer
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 answer
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof, work with java.lang.Class, etc.)?
Answer:No answer
Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading?
Answer:No answer
Question (security-policy): Does your functionality require modifications to the standard policy file?
WARNING: Question with id="security-policy" has not been answered!
Question (security-grant): Does your code grant additional rights to some other code?
WARNING: Question with id="security-grant" has not been answered!

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:No answer
Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop?
Answer:No answer
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:No answer

Performance and Scalability

Question (perf-startup): Does your module run any code on startup?
Answer:No answer
Question (perf-exit): Does your module run any code on exit?
Answer:No answer
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:No answer
Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle?
Answer:No answer
Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc.
Answer:No answer
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 answer
Question (perf-progress): Does your module execute any long-running tasks?
Answer:No answer
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 answer
Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic?
Answer:No answer
Question (perf-spi): How the performance of the plugged in code will be enforced?
Answer:No answer