On Nonnull Annotation Setting

[lucidfrontier45]

I found annotation based nonnull analysis was added from version 1.11.0. The README says there are two configurations java.compile.nullAnalysis.nonnull and java.compile.nullAnalysis.nullable in .vscode/settings.json .

When I read #1693 I also found we can set org.eclipse.jdt.core.compiler.annotation.nonnull and etc in the setting file specified by java.settings.url.

If I set both of them, which one will be used?

In addition, if I set org.eclipse.jdt.core.compiler.annotation.nonnullbydefault=org.eclipse.jdt.annotation.NonNullByDefault in the the file of java.settings.url, I got expected null check behaviour. Is there any equivalent direct setting in .vscode/settings.json ?

Environment

• Operating System: Ubuntu 22.04
• JDK version: OpenJDK 64-Bit Server VM (build 17.0.4+8-Ubuntu-122.04, mixed mode, sharing)
• Visual Studio Code version: 1.73.0
• Java extension version: 1.12.0

[rgrunber]

I think this would clash. The situation probably gets even more complicated because we introduced a new setting for the upcoming 1.13.0 release, java.compile.analysis.mode to make it easier for users to define how null analysis should activate.

java.compile.nullAnalysis.mode: Specify how to enable the annotation-based null analysis. Supported values are disabled (disable the null analysis), interactive (asks when null annotation types are detected), automatic (automatically enable null analysis when null annotation types are detected). Defaults to disabled.

My guess is if you want to define the settings yourself using java.settings.url, then I would make sure you set them to :

"java.compile.nullAnalysis.nonnull": []
"java.compile.nullAnalysis.nullable" : [],

Once 1.13.0 is released, or if you're using a pre-release, you should be able to instead set :

java.compile.nullAnalysis.mode: "disabled"

if you wish to control the settings manual.

CC'ing @CsCherrYY for comment.

[CsCherrYY]

The recommended way from my side is to use VS Code settings java.compile.nullAnalysis.nonnull, java.compile.nullAnalysis.nullable and incoming java.compile.nullAnalysis.mode.

If you're using a pre-release, null analysis related VS Code settings will override what you have set in java.settings.url. @lucidfrontier45 Does it work in your case?

@rgrunber the currently mechanism is designed for avoiding changing the VS Code settings out of the lifecycle of the extension. E.g., A user edits the mode when the extension is not activated yet or even the VS Code has not started yet. So the language server will check the settings and try to set new null analysis related setting in project options according to java.compile.nullAnalysis.nonnull, java.compile.nullAnalysis.nullable and incoming java.compile.nullAnalysis.mode.

[lucidfrontier45]

@rgrunber @CsCherrYY Thank you for the reply.

I currently leave java.compile.nullAnalysis.nonnull and java.compile.nullAnalysis.nullable to the default and append settings to the file of java.settings.url as follows

org.eclipse.jdt.core.compiler.annotation.nonnull=org.eclipse.jdt.annotation.Nonnull
org.eclipse.jdt.core.compiler.annotation.nonnull.secondary=
org.eclipse.jdt.core.compiler.annotation.nonnullbydefault=org.eclipse.jdt.annotation.NonNullByDefault
org.eclipse.jdt.core.compiler.annotation.nonnullbydefault.secondary=
org.eclipse.jdt.core.compiler.annotation.nullable=jorg.eclipse.jdt.annotation.Nullable
org.eclipse.jdt.core.compiler.annotation.nullable.secondary=
org.eclipse.jdt.core.compiler.annotation.nullanalysis=enabled

As you recommend to only use VSCode settings, what should I do if I also want to set org.eclipse.jdt.core.compiler.annotation.nonnullbydefault ?

[CsCherrYY]

@lucidfrontier45 thanks for the swift reply. Currently, we don't cover org.eclipse.jdt.core.compiler.annotation.nonnullbydefault since it's not such popular comparing to nonnull and nullable(and it's a little difficult to provide a default nonnullbydefault type list). So what you specify in java.settings.url will be still effective.

we will override the following settings according to VS Code settings as they are parts of basic null analysis and error level:

org.eclipse.jdt.core.compiler.annotation.nullanalysis
org.eclipse.jdt.core.compiler.annotation.nonnull
org.eclipse.jdt.core.compiler.annotation.nullable
org.eclipse.jdt.core.compiler.problem.nullReference
org.eclipse.jdt.core.compiler.problem.potentialNullReference
org.eclipse.jdt.core.compiler.problem.nullSpecViolation
org.eclipse.jdt.core.compiler.problem.nullAnnotationInferenceConflict

[lucidfrontier45]

@CsCherrYY I understand.

Let me confirm it. If I want to use org.eclipse.jdt.annotation.NonNullByDefault I have to keep using the following settings

org.eclipse.jdt.core.compiler.annotation.nonnull=org.eclipse.jdt.annotation.Nonnull
org.eclipse.jdt.core.compiler.annotation.nonnull.secondary=
org.eclipse.jdt.core.compiler.annotation.nonnullbydefault=org.eclipse.jdt.annotation.NonNullByDefault
org.eclipse.jdt.core.compiler.annotation.nonnullbydefault.secondary=
org.eclipse.jdt.core.compiler.annotation.nullable=jorg.eclipse.jdt.annotation.Nullable
org.eclipse.jdt.core.compiler.annotation.nullable.secondary=
org.eclipse.jdt.core.compiler.annotation.nullanalysis=enabled

and also set

• java.compile.nullAnalysis.nonnull to org.eclipse.jdt.annotation.Nonnull
• java.compile.nullAnalysis.nullable to org.eclipse.jdt.annotation.Nullable
• java.compile.nullAnalysis.mode to automatic (after 1.13.0).

Am I correct?

---

By the way, I think NonNullByDefault will be more and more important as it is the default behaviour in Java's alternative languages such as Kotlin and Rust. It will be great that this extension can also directly support it.

[CsCherrYY]

@lucidfrontier45 basically it's right. Besides, you can just put

org.eclipse.jdt.core.compiler.annotation.nonnullbydefault=org.eclipse.jdt.annotation.NonNullByDefault

it's enough for java.settings.url. the extension will automatically set other configurations for you according to VS Code settings java.compile.nullAnalysis.*.

As for the NonNullByDefault, thanks a lot for your information, we will investigate and find a way to properly support the null analysis completely.