NetBeans Architecture Answers for Java Hints SPI module

General Information

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

XXX no answer for arch-what

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

spi.java.hints - SPI to create custom Java hints, including code smell warnings, productivity tips, etc. Please see the Use Cases section for a guide on how to use this SPI.

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:

Creating a new Java Hint

Simple way to create a new Java hint is as follows:
• Create a new class, annotate it with the @Hint annotation to it.
• Create a public static ErrorDescription hint(HintContext ctx) {} method in the class. Annotate the method either with the @TriggerPattern annotation (strongly recommended), or with the @TriggerTreeKind. This method will be called when for parts of the code that match the given pattern, of for trees of the specified kinds.
• Perform whatever checks necessary to find out whether a warning should be produced at the given place, and produce the ErrorDescription if needed.

Tips:
• Always use the java.hints' ErrorDescriptionFactory to produce the resulting ErrorDescription.
• Never try to produce a custom suppress warnings "fix". Specify suppress warnings keys in the @Hint annotation.
• If an automated transformation is to be prodived from your hint, subclass JavaFix and use its toEditorFix() method to get the Fix, if the transformation is going to be used inside Inspect&Transform.
• The name of the method is arbitrary, one hint can consist of more that one "triggered" method.

Creating a new Java Hint Without a Class

For simple hints, it is possible to annotate the hint method with the @Hint annotation. The hint then consists of this sole method. Any number of such hints may be created in a single class.

Creating a Tests for the Newly Created Java Hint

Creating automated tests for the hints is simple: create a test class, and use HintTest to setup the test, run the hint and verify that its outcomes are correct. The tests automatically run with test branding, so create Bundle_test.properties, and add bundle keys into it for ErrorDescription and Fix display names, to isolate the test from changes in the production Bundle.properties.

Adding options to a Java Hint

To add a simple boolean option to your hint, use @BooleanOption.
Question (arch-time): What are the time estimates of the work?
Answer:

XXX no answer for arch-time

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

XXX no answer for arch-quality

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

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

Project and platform dependencies

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

These modules are required in project.xml:

• CommonAnnotationsAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.4 is required.
• JavaSupportAPIs - The module is needed for compilation. The module is used during runtime. Specification version 1.18 is required.
• ClassPathAPIs - The module is needed for compilation. The module is used during runtime. Specification version 1.24 is required.
• Progress - The module is needed for compilation. The module is used during runtime. Specification version 1.40 is required.
• ProgressSwing - The module is needed for compilation. The module is used during runtime. Specification version 1.40 is required.
• org.netbeans.lib.nbjavac - The module is needed for compilation. The module is used during runtime.
• org.netbeans.libs.javacapi - The module is needed for compilation. The module is used during runtime.
• org.netbeans.libs.lucene - The module is needed for compilation. The module is used during runtime. Specification version 3.0 is required.
• CodeAnalysis - The module is needed for compilation. The module is used during runtime. Specification version 1.8 is required.
• EditorModuleAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.53 is required.
• org.netbeans.modules.editor.document - The module is needed for compilation. The module is used during runtime. Specification version 1.3 is required.
• TextAPI - The module is needed for compilation. The module is used during runtime. Specification version 2.3 is required.
• EditorHyperlinkSPI - The module is needed for compilation. The module is used during runtime. Specification version 4.0 is required.
• editor-code-generator - The module is needed for compilation. The module is used during runtime. Specification version 2.0 is required.
• MimeLookupAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.15 is required.
• EditorSettingsAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.28 is required.
• EditorUtilitiesAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.33 is required.
• org.netbeans.modules.java.lexer - The module is needed for compilation. The module is used during runtime. Specification version 1.0 is required.
• JavaPlatformAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.16 is required.
• JavaProjectAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.62 is required.
• org.netbeans.modules.java.source - The module is needed for compilation. The module is used during runtime.
• JavaSourceAPI - The module is needed for compilation. The module is used during runtime.
• LexerAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.25 is required.
• OptionsDialogSPI - The module is needed for compilation. The module is used during runtime. Specification version 1.5 is required.
• org.netbeans.modules.options.editor - The module is needed for compilation. The module is used during runtime. Specification version 1.28 is required.
• ParsingAPI - The module is needed for compilation. The module is used during runtime.
• ProjectAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.42 is required.
• GeneralQueriesAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.18 is required.
• RefactoringAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.23 is required.
• EditorHintsSPI - The module is needed for compilation. The module is used during runtime. Specification version 1.22 is required.
• ActionsAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.15 is required.
• org.openide.awt - The module is needed for compilation. The module is used during runtime. Specification version 6.10 is required.
• DialogsAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.0 is required.
• ExplorerAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.22 is required.
• FilesystemsAPI - The module is needed for compilation. The module is used during runtime. Specification version 9.0 is required.
• LoadersAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.61 is required.
• ModulesAPI - The module is needed for compilation. The module is used during runtime. Specification version 7.3 is required.
• NodesAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.2 is required.
• EditorAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.16 is required.
• WeakListener.setAccessible - The module is needed for compilation. The module is used during runtime. Specification version 9.3 is required.
• LookupAPI - The module is needed for compilation. The module is used during runtime. Specification version 8.0 is required.
• UtilitiesAPI - The module is needed for compilation. The module is used during runtime. Specification version 9.3 is required.
• WindowSystemAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.16 is required.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:

XXX no answer for dep-non-nb

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

XXX no answer for dep-platform

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

XXX no answer for dep-jre

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

XXX no answer for dep-jrejdk

Deployment

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

XXX no answer for deploy-jar

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

XXX no answer for deploy-nbm

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:

XXX no answer for deploy-shared

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

XXX no answer for deploy-packages

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:

XXX no answer for deploy-dependencies

Compatibility with environment

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

XXX no answer for compat-i18n

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

XXX no answer for compat-standards

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:

XXX no answer for compat-version

Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product?
Answer:

XXX no answer for compat-deprecation

Access to resources

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

XXX no answer for resources-file

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:

XXX no answer for resources-layer

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

XXX no answer for resources-read

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

XXX no answer for resources-mask

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 ?
Answer:

XXX no answer for resources-preferences

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:

XXX no answer for lookup-lookup

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

XXX no answer for lookup-register

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

XXX no answer for lookup-remove

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:

XXX no answer for exec-property

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

XXX no answer for exec-component

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

XXX no answer for exec-ant-tasks

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

XXX no answer for exec-classloader

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

XXX no answer for exec-reflection

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

XXX no answer for exec-privateaccess

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:

XXX no answer for exec-process

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

XXX no answer for exec-introspection

Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading?
Answer:

XXX no answer for exec-threading

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

XXX no answer for security-policy

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

XXX no answer for security-grant

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:

XXX no answer for format-types

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

XXX no answer for format-dnd

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:

XXX no answer for format-clipboard

Performance and Scalability

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

XXX no answer for perf-startup

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

XXX no answer for perf-exit

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:

XXX no answer for perf-scale

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

XXX no answer for perf-limit

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

XXX no answer for perf-mem

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:

XXX no answer for perf-wakeup

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

XXX no answer for perf-progress

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:

XXX no answer for perf-huge_dialogs

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

XXX no answer for perf-menus

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

XXX no answer for perf-spi