Add nullability annotations to module/spring-boot-mongodb

See gh-46587

Author: mhalbritter

module/spring-boot-mongodb/build.gradle

@@ -28,6 +28,8 @@ description = "Spring Boot MongoDB"
 dependencies {
 	api(project(":core:spring-boot"))
 
+	compileOnly("com.google.code.findbugs:jsr305")
+
 	optional(project(":core:spring-boot-autoconfigure"))
 	optional(project(":core:spring-boot-docker-compose"))
 	optional(project(":core:spring-boot-testcontainers"))

module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/MongoClientFactorySupport.java

@@ -23,6 +23,7 @@
 import com.mongodb.MongoClientSettings;
 import com.mongodb.MongoClientSettings.Builder;
 import com.mongodb.MongoDriverInformation;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Base class for setup that is common to MongoDB client factories.
@@ -38,7 +39,7 @@ public abstract class MongoClientFactorySupport<T> {
 
 	private final BiFunction<MongoClientSettings, MongoDriverInformation, T> clientCreator;
 
-	protected MongoClientFactorySupport(List<MongoClientSettingsBuilderCustomizer> builderCustomizers,
+	protected MongoClientFactorySupport(@Nullable List<MongoClientSettingsBuilderCustomizer> builderCustomizers,
 			BiFunction<MongoClientSettings, MongoDriverInformation, T> clientCreator) {
 		this.builderCustomizers = (builderCustomizers != null) ? builderCustomizers : Collections.emptyList();
 		this.clientCreator = clientCreator;

module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/MongoConnectionDetails.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.mongodb.autoconfigure;
 
 import com.mongodb.ConnectionString;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.autoconfigure.service.connection.ConnectionDetails;
 import org.springframework.boot.ssl.SslBundle;
@@ -41,15 +42,15 @@ public interface MongoConnectionDetails extends ConnectionDetails {
 	 * SSL bundle to use.
 	 * @return the SSL bundle to use
 	 */
-	default SslBundle getSslBundle() {
+	default @Nullable SslBundle getSslBundle() {
 		return null;
 	}
 
 	/**
 	 * GridFS configuration.
 	 * @return the GridFS configuration or {@code null}
 	 */
-	default GridFs getGridFs() {
+	default @Nullable GridFs getGridFs() {
 		return null;
 	}
 
@@ -62,30 +63,30 @@ interface GridFs {
 		 * GridFS database name.
 		 * @return the GridFS database name or {@code null}
 		 */
-		String getDatabase();
+		@Nullable String getDatabase();
 
 		/**
 		 * GridFS bucket name.
 		 * @return the GridFS bucket name or {@code null}
 		 */
-		String getBucket();
+		@Nullable String getBucket();
 
 		/**
 		 * Factory method to create a new {@link GridFs} instance.
 		 * @param database the database
 		 * @param bucket the bucket name
 		 * @return a new {@link GridFs} instance
 		 */
-		static GridFs of(String database, String bucket) {
+		static GridFs of(@Nullable String database, @Nullable String bucket) {
 			return new GridFs() {
 
 				@Override
-				public String getDatabase() {
+				public @Nullable String getDatabase() {
 					return database;
 				}
 
 				@Override
-				public String getBucket() {
+				public @Nullable String getBucket() {
 					return bucket;
 				}
 

module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/MongoProperties.java

@@ -20,6 +20,7 @@
 
 import com.mongodb.ConnectionString;
 import org.bson.UuidRepresentation;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
@@ -59,56 +60,56 @@ public class MongoProperties {
 	/**
 	 * Mongo server host. Ignored if 'uri' is set.
 	 */
-	private String host;
+	private @Nullable String host;
 
 	/**
 	 * Mongo server port. Ignored if 'uri' is set.
 	 */
-	private Integer port = null;
+	private @Nullable Integer port;
 
 	/**
 	 * Additional server hosts. Ignored if 'uri' is set or if 'host' is omitted.
 	 * Additional hosts will use the default mongo port of 27017. If you want to use a
 	 * different port you can use the "host:port" syntax.
 	 */
-	private List<String> additionalHosts;
+	private @Nullable List<String> additionalHosts;
 
 	/**
 	 * Mongo database URI. Overrides host, port, username, and password.
 	 */
-	private String uri;
+	private @Nullable String uri;
 
 	/**
 	 * Database name. Overrides database in URI.
 	 */
-	private String database;
+	private @Nullable String database;
 
 	/**
 	 * Authentication database name.
 	 */
-	private String authenticationDatabase;
+	private @Nullable String authenticationDatabase;
 
 	private final Gridfs gridfs = new Gridfs();
 
 	/**
 	 * Login user of the mongo server. Ignored if 'uri' is set.
 	 */
-	private String username;
+	private @Nullable String username;
 
 	/**
 	 * Login password of the mongo server. Ignored if 'uri' is set.
 	 */
-	private char[] password;
+	private char @Nullable [] password;
 
 	/**
 	 * Required replica set name for the cluster. Ignored if 'uri' is set.
 	 */
-	private String replicaSetName;
+	private @Nullable String replicaSetName;
 
 	/**
 	 * Fully qualified name of the FieldNamingStrategy to use.
 	 */
-	private Class<?> fieldNamingStrategy;
+	private @Nullable Class<?> fieldNamingStrategy;
 
 	/**
 	 * Representation to use when converting a UUID to a BSON binary value.
@@ -120,7 +121,7 @@ public class MongoProperties {
 	/**
 	 * Whether to enable auto-index creation.
 	 */
-	private Boolean autoIndexCreation;
+	private @Nullable Boolean autoIndexCreation;
 
 	public void setProtocol(String protocol) {
 		this.protocol = protocol;
@@ -130,59 +131,59 @@ public String getProtocol() {
 		return this.protocol;
 	}
 
-	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 String getDatabase() {
+	public @Nullable String getDatabase() {
 		return this.database;
 	}
 
-	public void setDatabase(String database) {
+	public void setDatabase(@Nullable String database) {
 		this.database = database;
 	}
 
-	public String getAuthenticationDatabase() {
+	public @Nullable String getAuthenticationDatabase() {
 		return this.authenticationDatabase;
 	}
 
-	public void setAuthenticationDatabase(String authenticationDatabase) {
+	public void setAuthenticationDatabase(@Nullable String authenticationDatabase) {
 		this.authenticationDatabase = authenticationDatabase;
 	}
 
-	public String getUsername() {
+	public @Nullable String getUsername() {
 		return this.username;
 	}
 
-	public void setUsername(String username) {
+	public void setUsername(@Nullable String username) {
 		this.username = username;
 	}
 
-	public char[] getPassword() {
+	public char @Nullable [] getPassword() {
 		return this.password;
 	}
 
-	public void setPassword(char[] password) {
+	public void setPassword(char @Nullable [] password) {
 		this.password = password;
 	}
 
-	public String getReplicaSetName() {
+	public @Nullable String getReplicaSetName() {
 		return this.replicaSetName;
 	}
 
-	public void setReplicaSetName(String replicaSetName) {
+	public void setReplicaSetName(@Nullable String replicaSetName) {
 		this.replicaSetName = replicaSetName;
 	}
 
-	public Class<?> getFieldNamingStrategy() {
+	public @Nullable Class<?> getFieldNamingStrategy() {
 		return this.fieldNamingStrategy;
 	}
 
-	public void setFieldNamingStrategy(Class<?> fieldNamingStrategy) {
+	public void setFieldNamingStrategy(@Nullable Class<?> fieldNamingStrategy) {
 		this.fieldNamingStrategy = fieldNamingStrategy;
 	}
 
@@ -194,50 +195,50 @@ public void setUuidRepresentation(UuidRepresentation uuidRepresentation) {
 		this.uuidRepresentation = uuidRepresentation;
 	}
 
-	public String getUri() {
+	public @Nullable String getUri() {
 		return this.uri;
 	}
 
 	public String determineUri() {
 		return (this.uri != null) ? this.uri : DEFAULT_URI;
 	}
 
-	public void setUri(String uri) {
+	public void setUri(@Nullable String uri) {
 		this.uri = uri;
 	}
 
-	public Integer getPort() {
+	public @Nullable Integer getPort() {
 		return this.port;
 	}
 
-	public void setPort(Integer port) {
+	public void setPort(@Nullable Integer port) {
 		this.port = port;
 	}
 
 	public Gridfs getGridfs() {
 		return this.gridfs;
 	}
 
-	public String getMongoClientDatabase() {
+	public @Nullable String getMongoClientDatabase() {
 		if (this.database != null) {
 			return this.database;
 		}
 		return new ConnectionString(determineUri()).getDatabase();
 	}
 
-	public Boolean isAutoIndexCreation() {
+	public @Nullable Boolean isAutoIndexCreation() {
 		return this.autoIndexCreation;
 	}
 
-	public void setAutoIndexCreation(Boolean autoIndexCreation) {
+	public void setAutoIndexCreation(@Nullable Boolean autoIndexCreation) {
 		this.autoIndexCreation = autoIndexCreation;
 	}
 
-	public List<String> getAdditionalHosts() {
+	public @Nullable List<String> getAdditionalHosts() {
 		return this.additionalHosts;
 	}
 
-	public void setAdditionalHosts(List<String> additionalHosts) {
+	public void setAdditionalHosts(@Nullable List<String> additionalHosts) {
 		this.additionalHosts = additionalHosts;
 	}
 
@@ -250,26 +251,26 @@ public static class Gridfs {
 		/**
 		 * GridFS database name.
 		 */
-		private String database;
+		private @Nullable String database;
 
 		/**
 		 * GridFS bucket name.
 		 */
-		private String bucket;
+		private @Nullable String bucket;
 
-		public String getDatabase() {
+		public @Nullable String getDatabase() {
 			return this.database;
 		}
 
-		public void setDatabase(String database) {
+		public void setDatabase(@Nullable String database) {
 			this.database = database;
 		}
 
-		public String getBucket() {
+		public @Nullable String getBucket() {
 			return this.bucket;
 		}
 
-		public void setBucket(String bucket) {
+		public void setBucket(@Nullable String bucket) {
 			this.bucket = bucket;
 		}
 
@@ -281,12 +282,12 @@ public static class Ssl {
 		 * Whether to enable SSL support. Enabled automatically if "bundle" is provided
 		 * unless specified otherwise.
 		 */
-		private Boolean enabled;
+		private @Nullable Boolean enabled;
 
 		/**
 		 * SSL bundle name.
 		 */
-		private String bundle;
+		private @Nullable String bundle;
 
 		public boolean isEnabled() {
 			return (this.enabled != null) ? this.enabled : this.bundle != null;
@@ -296,11 +297,11 @@ public void setEnabled(boolean enabled) {
 			this.enabled = enabled;
 		}
 
-		public String getBundle() {
+		public @Nullable String getBundle() {
 			return this.bundle;
 		}
 
-		public void setBundle(String bundle) {
+		public void setBundle(@Nullable String bundle) {
 			this.bundle = bundle;
 		}
 

module/spring-boot-mongodb/src/main/java/org/springframework/boot/mongodb/autoconfigure/MongoReactiveAutoConfiguration.java

@@ -24,6 +24,7 @@
 import io.netty.channel.MultiThreadIoEventLoopGroup;
 import io.netty.channel.nio.NioIoHandler;
 import io.netty.channel.socket.SocketChannel;
+import org.jspecify.annotations.Nullable;
 import reactor.core.publisher.Flux;
 
 import org.springframework.beans.factory.DisposableBean;
@@ -107,7 +108,7 @@ static final class NettyDriverMongoClientSettingsBuilderCustomizer
 
 		private final ObjectProvider<MongoClientSettings> settings;
 
-		private volatile EventLoopGroup eventLoopGroup;
+		private volatile @Nullable EventLoopGroup eventLoopGroup;
 
 		NettyDriverMongoClientSettingsBuilderCustomizer(ObjectProvider<MongoClientSettings> settings) {
 			this.settings = settings;
@@ -130,7 +131,7 @@ public void destroy() {
 			}
 		}
 
-		private boolean isCustomTransportConfiguration(MongoClientSettings settings) {
+		private boolean isCustomTransportConfiguration(@Nullable MongoClientSettings settings) {
 			return settings != null && settings.getTransportSettings() != null;
 		}