Add nullability annotations to module/spring-boot-devtools

See gh-46587

Author: mhalbritter

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/RemoteUrlPropertyExtractor.java

@@ -21,6 +21,8 @@
 import java.util.Collections;
 import java.util.Map;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
 import org.springframework.context.ApplicationListener;
 import org.springframework.core.Ordered;
@@ -59,7 +61,7 @@ public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
 		environment.getPropertySources().addLast(propertySource);
 	}
 
-	private String cleanRemoteUrl(String url) {
+	private @Nullable String cleanRemoteUrl(@Nullable String url) {
 		if (StringUtils.hasText(url) && url.endsWith("/")) {
 			return url.substring(0, url.length() - 1);
 		}

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/ConditionEvaluationDeltaLoggingListener.java

@@ -41,6 +41,7 @@ class ConditionEvaluationDeltaLoggingListener
 
 	private static final Log logger = LogFactory.getLog(ConditionEvaluationDeltaLoggingListener.class);
 
+	@SuppressWarnings("NullAway.Init")
 	private volatile ApplicationContext context;
 
 	@Override

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsDataSourceAutoConfiguration.java

@@ -25,10 +25,12 @@
 import javax.sql.DataSource;
 
 import org.apache.derby.jdbc.EmbeddedDriver;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
 import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionMessage;
@@ -50,6 +52,7 @@
 import org.springframework.core.type.AnnotatedTypeMetadata;
 import org.springframework.orm.jpa.AbstractEntityManagerFactoryBean;
 import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
+import org.springframework.util.Assert;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for DevTools-specific
@@ -136,13 +139,13 @@ private enum InMemoryDatabase {
 			HSQLDB("jdbc:hsqldb:mem:", Set.of("org.hsqldb.jdbcDriver", "org.hsqldb.jdbc.JDBCDriver",
 					"org.hsqldb.jdbc.pool.JDBCXADataSource"));
 
-			private final String urlPrefix;
+			private final @Nullable String urlPrefix;
 
 			private final ShutdownHandler shutdownHandler;
 
 			private final Set<String> driverClassNames;
 
-			InMemoryDatabase(String urlPrefix, Set<String> driverClassNames) {
+			InMemoryDatabase(@Nullable String urlPrefix, Set<String> driverClassNames) {
 				this(urlPrefix, driverClassNames, (dataSource) -> {
 					try (Connection connection = dataSource.getConnection()) {
 						try (Statement statement = connection.createStatement()) {
@@ -152,7 +155,8 @@ private enum InMemoryDatabase {
 				});
 			}
 
-			InMemoryDatabase(String urlPrefix, Set<String> driverClassNames, ShutdownHandler shutdownHandler) {
+			InMemoryDatabase(@Nullable String urlPrefix, Set<String> driverClassNames,
+					ShutdownHandler shutdownHandler) {
 				this.urlPrefix = urlPrefix;
 				this.driverClassNames = driverClassNames;
 				this.shutdownHandler = shutdownHandler;
@@ -189,11 +193,13 @@ public ConfigurationPhase getConfigurationPhase() {
 		@Override
 		public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
 			ConditionMessage.Builder message = ConditionMessage.forCondition("DevTools DataSource Condition");
-			String[] dataSourceBeanNames = context.getBeanFactory().getBeanNamesForType(DataSource.class, true, false);
+			ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
+			Assert.state(beanFactory != null, "'beanFactory' must not be null");
+			String[] dataSourceBeanNames = beanFactory.getBeanNamesForType(DataSource.class, true, false);
 			if (dataSourceBeanNames.length != 1) {
 				return ConditionOutcome.noMatch(message.didNotFind("a single DataSource bean").atAll());
 			}
-			if (context.getBeanFactory().getBeanNamesForType(DataSourceProperties.class, true, false).length != 1) {
+			if (beanFactory.getBeanNamesForType(DataSourceProperties.class, true, false).length != 1) {
 				return ConditionOutcome.noMatch(message.didNotFind("a single DataSourceProperties bean").atAll());
 			}
 			BeanDefinition dataSourceDefinition = context.getRegistry().getBeanDefinition(dataSourceBeanNames[0]);

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsProperties.java

@@ -21,6 +21,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.util.StringUtils;
@@ -76,7 +78,7 @@ public static class Restart {
 		/**
 		 * Additional patterns that should be excluded from triggering a full restart.
 		 */
-		private String additionalExclude;
+		private @Nullable String additionalExclude;
 
 		/**
 		 * Amount of time to wait between polling for classpath changes.
@@ -94,7 +96,7 @@ public static class Restart {
 		 * a simple name (without any path) of a file that appears on your classpath. If
 		 * not specified, any classpath file change triggers the restart.
 		 */
-		private String triggerFile;
+		private @Nullable String triggerFile;
 
 		/**
 		 * Additional paths to watch for changes.
@@ -133,11 +135,11 @@ public void setExclude(String exclude) {
 			this.exclude = exclude;
 		}
 
-		public String getAdditionalExclude() {
+		public @Nullable String getAdditionalExclude() {
 			return this.additionalExclude;
 		}
 
-		public void setAdditionalExclude(String additionalExclude) {
+		public void setAdditionalExclude(@Nullable String additionalExclude) {
 			this.additionalExclude = additionalExclude;
 		}
 
@@ -157,11 +159,11 @@ public void setQuietPeriod(Duration quietPeriod) {
 			this.quietPeriod = quietPeriod;
 		}
 
-		public String getTriggerFile() {
+		public @Nullable String getTriggerFile() {
 			return this.triggerFile;
 		}
 
-		public void setTriggerFile(String triggerFile) {
+		public void setTriggerFile(@Nullable String triggerFile) {
 			this.triggerFile = triggerFile;
 		}
 

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/DevToolsR2dbcAutoConfiguration.java

@@ -18,12 +18,14 @@
 
 import io.r2dbc.spi.Connection;
 import io.r2dbc.spi.ConnectionFactory;
+import org.jspecify.annotations.Nullable;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Mono;
 
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
 import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionMessage;
@@ -40,6 +42,7 @@
 import org.springframework.context.annotation.ConfigurationCondition;
 import org.springframework.core.type.AnnotatedTypeMetadata;
 import org.springframework.core.type.MethodMetadata;
+import org.springframework.util.Assert;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for DevTools-specific R2DBC
@@ -99,7 +102,7 @@ private Publisher<Void> closeConnection(Connection connection) {
 			return closeConnection(connection, null);
 		}
 
-		private Publisher<Void> closeConnection(Connection connection, Throwable ex) {
+		private Publisher<Void> closeConnection(Connection connection, @Nullable Throwable ex) {
 			return connection.close();
 		}
 
@@ -115,7 +118,9 @@ public ConfigurationPhase getConfigurationPhase() {
 		@Override
 		public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
 			ConditionMessage.Builder message = ConditionMessage.forCondition("DevTools ConnectionFactory Condition");
-			String[] beanNames = context.getBeanFactory().getBeanNamesForType(ConnectionFactory.class, true, false);
+			ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
+			Assert.state(beanFactory != null, "'beanFactory' must not be null");
+			String[] beanNames = beanFactory.getBeanNamesForType(ConnectionFactory.class, true, false);
 			if (beanNames.length != 1) {
 				return ConditionOutcome.noMatch(message.didNotFind("a single ConnectionFactory bean").atAll());
 			}

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/LocalDevToolsAutoConfiguration.java

@@ -22,6 +22,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
@@ -49,6 +50,7 @@
 import org.springframework.context.event.GenericApplicationListener;
 import org.springframework.core.ResolvableType;
 import org.springframework.core.log.LogMessage;
+import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
 /**
@@ -116,6 +118,7 @@ RestartingClassPathChangeChangedEventListener restartingClassPathChangedEventLis
 		ClassPathFileSystemWatcher classPathFileSystemWatcher(FileSystemWatcherFactory fileSystemWatcherFactory,
 				ClassPathRestartStrategy classPathRestartStrategy) {
 			URL[] urls = Restarter.getInstance().getInitialUrls();
+			Assert.state(urls != null, "'urls' must not be null");
 			ClassPathFileSystemWatcher watcher = new ClassPathFileSystemWatcher(fileSystemWatcherFactory,
 					classPathRestartStrategy, urls);
 			watcher.setStopWatcherOnRestart(true);
@@ -176,7 +179,7 @@ public boolean supportsEventType(ResolvableType eventType) {
 		}
 
 		@Override
-		public boolean supportsSourceType(Class<?> sourceType) {
+		public boolean supportsSourceType(@Nullable Class<?> sourceType) {
 			return true;
 		}
 

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/OptionalLiveReloadServer.java

@@ -18,6 +18,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.boot.devtools.livereload.LiveReloadServer;
@@ -34,13 +35,13 @@ public class OptionalLiveReloadServer implements InitializingBean {
 
 	private static final Log logger = LogFactory.getLog(OptionalLiveReloadServer.class);
 
-	private LiveReloadServer server;
+	private @Nullable LiveReloadServer server;
 
 	/**
 	 * Create a new {@link OptionalLiveReloadServer} instance.
 	 * @param server the server to manage or {@code null}
 	 */
-	public OptionalLiveReloadServer(LiveReloadServer server) {
+	public OptionalLiveReloadServer(@Nullable LiveReloadServer server) {
 		this.server = server;
 	}
 

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsAutoConfiguration.java

@@ -48,6 +48,7 @@
 import org.springframework.context.annotation.Import;
 import org.springframework.core.log.LogMessage;
 import org.springframework.http.server.ServerHttpRequest;
+import org.springframework.util.Assert;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for remote development support.
@@ -78,7 +79,9 @@ public final class RemoteDevToolsAutoConfiguration {
 	@ConditionalOnMissingBean
 	AccessManager remoteDevToolsAccessManager() {
 		RemoteDevToolsProperties remoteProperties = this.properties.getRemote();
-		return new HttpHeaderAccessManager(remoteProperties.getSecretHeaderName(), remoteProperties.getSecret());
+		String secret = remoteProperties.getSecret();
+		Assert.state(secret != null, "'secret' must not be null");
+		return new HttpHeaderAccessManager(remoteProperties.getSecretHeaderName(), secret);
 	}
 
 	@Bean

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/RemoteDevToolsProperties.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.devtools.autoconfigure;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Configuration properties for remote Spring Boot applications.
  *
@@ -39,7 +41,7 @@ public class RemoteDevToolsProperties {
 	 * A shared secret required to establish a connection (required to enable remote
 	 * support).
 	 */
-	private String secret;
+	private @Nullable String secret;
 
 	/**
 	 * HTTP header used to transfer the shared secret.
@@ -58,11 +60,11 @@ public void setContextPath(String contextPath) {
 		this.contextPath = contextPath;
 	}
 
-	public String getSecret() {
+	public @Nullable String getSecret() {
 		return this.secret;
 	}
 
-	public void setSecret(String secret) {
+	public void setSecret(@Nullable String secret) {
 		this.secret = secret;
 	}
 
@@ -104,26 +106,26 @@ public static class Proxy {
 		/**
 		 * The host of the proxy to use to connect to the remote application.
 		 */
-		private String host;
+		private @Nullable String host;
 
 		/**
 		 * The port of the proxy to use to connect to the remote application.
 		 */
-		private Integer port;
+		private @Nullable Integer port;
 
-		public String getHost() {
+		public @Nullable String getHost() {
 			return this.host;
 		}
 
-		public void setHost(String host) {
+		public void setHost(@Nullable String host) {
 			this.host = host;
 		}
 
-		public Integer getPort() {
+		public @Nullable Integer getPort() {
 			return this.port;
 		}
 
-		public void setPort(Integer port) {
+		public void setPort(@Nullable Integer port) {
 			this.port = port;
 		}
 

module/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/autoconfigure/package-info.java

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for {@code spring-boot-devtools}.
  */
+@NullMarked
 package org.springframework.boot.devtools.autoconfigure;
+
+import org.jspecify.annotations.NullMarked;