NetBeans Architecture Answers for Editor Hints module

General Information

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

XXX no answer.

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

EditorHintsSPI - allows to show errors in the editor, with possible fixes.

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:

redunderline

Assume that you have a module using e.g. Parsing API to parse the source files and wants to mark the errors in the editor to be shown as red underlined in the editor. Here is the pseudo code that achieves this:

                            Document doc = ...;
ArrayList<ErrorDescription> errors = new ArrayList<ErrorDescription>();
for (<all errors from the parser that have parsed the doc>) {
    errors.add(
        ErrorDescriptionFactory.createErrorDescription(
            Severity.ERROR,
            d.getMessage(Locale.getDefault()),
            doc,
            doc.createPosition(start),
            doc.createPosition(end)
        )
    );
}
HintsController.setErrors(doc, "myerrors", errors);

                        

warningwithfix

Adding a warning with fixes:

                            static final class FixImpl implements Fix {
...
}
...
Document doc = ...;
List<Fix> fixes = Arrays.<Fix>asList(new FixImpl(...));
ArrayList<ErrorDescription> warnings = new ArrayList<ErrorDescription>();
for (<all places where the warning should be displayed>) {
    warnings.add(
        ErrorDescriptionFactory.createErrorDescription(
            Severity.WARNING,
            displayName,
            fixes,
            doc,
            doc.createPosition(start),
            doc.createPosition(end)
        )
    );
}
HintsController.setErrors(doc, "mywarnings", warnings);

                        

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

The work has already been done.

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

The qualit of the feature was proven by being used by dozens of modules for several releases. There are also some unit tests.

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.6 is required.
• LanguageServerAPIs - The module is needed for compilation. The module is used during runtime. Specification version 1.9 is required.
• org.netbeans.modules.editor.document - The module is needed for compilation. The module is used during runtime. Specification version 1.0 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.
• MimeLookupAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.1 is required.
• EditorSettingsAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.11 is required.
• EditorUtilitiesAPI - The module is needed for compilation. The module is used during runtime. Specification version 1.17 is required.
• org.openide.awt - The module is needed for compilation. The module is used during runtime. Specification version 7.82 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 6.3 is required.
• NodesAPI - The module is needed for compilation. The module is used during runtime. Specification version 6.5 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.5 is required.
Question (dep-non-nb): What other projects outside NetBeans does this one depend on?
Answer:

No external dependencies.

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

The module is platform agnostic.

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

There is not direct JRE dependency --- the module should run on whatever version the current NB version runs on.

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

JRE is enough.

Deployment

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

Only module jars are deployed for this module.

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:

The module can be installed anywhere.

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

Yes, only SPI package is exposed as public.

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:

Normal module dependencies are used for this module.

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:

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:

This is API addition, no deprecation or replacements.

Access to resources

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

No.

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:

Yes. The module registers editor annotations types under Editors/AnnotationTypes, actions into the gutter of the editor to Editors/GlyphGutterActions, actions to main menu and shortcuts.

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:

No.

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:

No.

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.

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

No.

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:

No.

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

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:

There is nothing written to the disk or network by this module.

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

The module does not participate in DnD operations.

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:

The module does not use the clipboard.

Performance and Scalability

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

No.

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:

The main factor to scale is the size of the opened files in the editor.

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

There are only practival limits of the code e.g. nobody have ever tried to create tens of thousands of hints.

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

I have no idea how much memory the module consumes.

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:

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:

No.

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:

There is no enforcement of the performance of the plugged in code.