Add nullability annotations to cli/spring-boot-cli

See gh-46587

Author: mhalbritter

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/AbstractCommand.java

@@ -19,6 +19,8 @@
 import java.util.Collection;
 import java.util.Collections;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.cli.command.options.OptionHelp;
 
 /**
@@ -55,12 +57,12 @@ public String getDescription() {
 	}
 
 	@Override
-	public String getUsageHelp() {
+	public @Nullable String getUsageHelp() {
 		return null;
 	}
 
 	@Override
-	public String getHelp() {
+	public @Nullable String getHelp() {
 		return null;
 	}
 
@@ -70,7 +72,7 @@ public Collection<OptionHelp> getOptionsHelp() {
 	}
 
 	@Override
-	public Collection<HelpExample> getExamples() {
+	public @Nullable Collection<HelpExample> getExamples() {
 		return null;
 	}
 

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/Command.java

@@ -18,6 +18,8 @@
 
 import java.util.Collection;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.cli.command.options.OptionHelp;
 import org.springframework.boot.cli.command.status.ExitStatus;
 
@@ -50,14 +52,14 @@ public interface Command {
 	 * the command in this string.
 	 * @return the command's usage help
 	 */
-	String getUsageHelp();
+	@Nullable String getUsageHelp();
 
 	/**
 	 * Gets full help text for the command, e.g. a longer description and one line per
 	 * option.
 	 * @return the command's help text
 	 */
-	String getHelp();
+	@Nullable String getHelp();
 
 	/**
 	 * Returns help for each supported option.
@@ -69,7 +71,7 @@ public interface Command {
 	 * Return some examples for the command.
 	 * @return the command's examples
 	 */
-	Collection<HelpExample> getExamples();
+	@Nullable Collection<HelpExample> getExamples();
 
 	/**
 	 * Run the command.

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/CommandException.java

@@ -21,6 +21,8 @@
 import java.util.EnumSet;
 import java.util.Set;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Runtime exception wrapper that defines additional {@link Option}s that are understood
  * by the {@link CommandRunner}.
@@ -73,7 +75,7 @@ public CommandException(Throwable cause, Option... options) {
 		this.options = asEnumSet(options);
 	}
 
-	private EnumSet<Option> asEnumSet(Option[] options) {
+	private EnumSet<Option> asEnumSet(Option @Nullable [] options) {
 		if (options == null || options.length == 0) {
 			return EnumSet.noneOf(Option.class);
 		}

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/CommandRunner.java

@@ -24,6 +24,8 @@
 import java.util.List;
 import java.util.Set;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.cli.command.status.ExitStatus;
 import org.springframework.boot.cli.util.Log;
 import org.springframework.util.Assert;
@@ -54,7 +56,7 @@ public class CommandRunner implements Iterable<Command> {
 	 * Create a new {@link CommandRunner} instance.
 	 * @param name the name of the runner or {@code null}
 	 */
-	public CommandRunner(String name) {
+	public CommandRunner(@Nullable String name) {
 		this.name = StringUtils.hasLength(name) ? name + " " : "";
 	}
 
@@ -146,7 +148,7 @@ protected final List<Command> getCommands() {
 	 * @param name the name of the command
 	 * @return the command or {@code null} if not found
 	 */
-	public Command findCommand(String name) {
+	public @Nullable Command findCommand(String name) {
 		for (Command candidate : this.commands) {
 			String candidateName = candidate.getName();
 			if (candidateName.equals(name) || (isOptionCommand(candidate) && ("--" + candidateName).equals(name))) {
@@ -258,7 +260,7 @@ private int handleError(boolean debug, Exception ex) {
 		return 1;
 	}
 
-	protected boolean errorMessage(String message) {
+	protected boolean errorMessage(@Nullable String message) {
 		Log.error((message != null) ? message : "Unexpected error");
 		return message != null;
 	}

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/core/HelpCommand.java

@@ -22,6 +22,8 @@
 import java.util.List;
 import java.util.Set;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.cli.command.AbstractCommand;
 import org.springframework.boot.cli.command.Command;
 import org.springframework.boot.cli.command.CommandRunner;
@@ -53,7 +55,7 @@ public String getUsageHelp() {
 	}
 
 	@Override
-	public String getHelp() {
+	public @Nullable String getHelp() {
 		return null;
 	}
 

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/core/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Core CLI commands.
  */
+@NullMarked
 package org.springframework.boot.cli.command.core;
+
+import org.jspecify.annotations.NullMarked;

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/encodepassword/EncodePasswordCommand.java

@@ -79,6 +79,7 @@ public Collection<HelpExample> getExamples() {
 
 	private static final class EncodePasswordOptionHandler extends OptionHandler {
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> algorithm;
 
 		@Override

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/encodepassword/package-info.java

@@ -17,4 +17,7 @@
 /**
  * CLI command for password encoding.
  */
+@NullMarked
 package org.springframework.boot.cli.command.encodepassword;
+
+import org.jspecify.annotations.NullMarked;

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/Dependency.java

@@ -16,34 +16,36 @@
 
 package org.springframework.boot.cli.command.init;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Provide some basic information about a dependency.
  *
  * @author Stephane Nicoll
  */
 final class Dependency {
 
-	private final String id;
+	private final @Nullable String id;
 
-	private final String name;
+	private final @Nullable String name;
 
-	private final String description;
+	private final @Nullable String description;
 
-	Dependency(String id, String name, String description) {
+	Dependency(@Nullable String id, @Nullable String name, @Nullable String description) {
 		this.id = id;
 		this.name = name;
 		this.description = description;
 	}
 
-	String getId() {
+	@Nullable String getId() {
 		return this.id;
 	}
 
-	String getName() {
+	@Nullable String getName() {
 		return this.name;
 	}
 
-	String getDescription() {
+	@Nullable String getDescription() {
 		return this.description;
 	}
 

cli/spring-boot-cli/src/main/java/org/springframework/boot/cli/command/init/InitCommand.java

@@ -94,40 +94,58 @@ static class InitOptionHandler extends OptionHandler {
 
 		private final ProjectGenerator projectGenerator;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> target;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<Void> listCapabilities;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> groupId;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> artifactId;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> version;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> name;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> description;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> packageName;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> type;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> packaging;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> build;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> format;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> javaVersion;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> language;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> bootVersion;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<String> dependencies;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<Void> extract;
 
+		@SuppressWarnings("NullAway.Init")
 		private OptionSpec<Void> force;
 
 		InitOptionHandler(InitializrService initializrService) {