Add nullability annotations to module/spring-boot-hibernate

See gh-46587

Author: mhalbritter

documentation/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/howto/dataaccess/configurehibernatesecondlevelcaching/MyHibernateSecondLevelCacheConfiguration.kt

@@ -28,7 +28,10 @@ class MyHibernateSecondLevelCacheConfiguration {
 	@Bean
 	fun hibernateSecondLevelCacheCustomizer(cacheManager: JCacheCacheManager): HibernatePropertiesCustomizer {
 		return HibernatePropertiesCustomizer { properties ->
-			properties[ConfigSettings.CACHE_MANAGER] = cacheManager.cacheManager
+			val cacheManager = cacheManager.cacheManager
+			if (cacheManager != null) {
+				properties[ConfigSettings.CACHE_MANAGER] = cacheManager
+			}
 		}
 	}
 

module/spring-boot-hibernate/src/main/java/org/springframework/boot/hibernate/SpringJtaPlatform.java

@@ -44,11 +44,13 @@ public SpringJtaPlatform(JtaTransactionManager transactionManager) {
 	}
 
 	@Override
+	@SuppressWarnings("NullAway") // TODO: Not sure about returning nullness here
 	protected TransactionManager locateTransactionManager() {
 		return this.transactionManager.getTransactionManager();
 	}
 
 	@Override
+	@SuppressWarnings("NullAway") // TODO: Not sure about returning nullness here
 	protected UserTransaction locateUserTransaction() {
 		return this.transactionManager.getUserTransaction();
 	}

module/spring-boot-hibernate/src/main/java/org/springframework/boot/hibernate/autoconfigure/HibernateJpaConfiguration.java

@@ -33,6 +33,7 @@
 import org.hibernate.boot.model.naming.PhysicalNamingStrategy;
 import org.hibernate.boot.model.naming.PhysicalNamingStrategySnakeCaseImpl;
 import org.hibernate.cfg.ManagedBeanSettings;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.aot.hint.MemberCategory;
 import org.springframework.aot.hint.RuntimeHints;
@@ -122,8 +123,8 @@ class HibernateJpaConfiguration extends JpaBaseConfiguration {
 	}
 
 	private List<HibernatePropertiesCustomizer> determineHibernatePropertiesCustomizers(
-			PhysicalNamingStrategy physicalNamingStrategy, ImplicitNamingStrategy implicitNamingStrategy,
-			ConfigurableListableBeanFactory beanFactory,
+			@Nullable PhysicalNamingStrategy physicalNamingStrategy,
+			@Nullable ImplicitNamingStrategy implicitNamingStrategy, ConfigurableListableBeanFactory beanFactory,
 			List<HibernatePropertiesCustomizer> hibernatePropertiesCustomizers) {
 		List<HibernatePropertiesCustomizer> customizers = new ArrayList<>();
 		if (ClassUtils.isPresent("org.hibernate.resource.beans.container.spi.BeanContainer",
@@ -237,12 +238,12 @@ private Object getNoJtaPlatformManager() {
 
 	private static class NamingStrategiesHibernatePropertiesCustomizer implements HibernatePropertiesCustomizer {
 
-		private final PhysicalNamingStrategy physicalNamingStrategy;
+		private final @Nullable PhysicalNamingStrategy physicalNamingStrategy;
 
-		private final ImplicitNamingStrategy implicitNamingStrategy;
+		private final @Nullable ImplicitNamingStrategy implicitNamingStrategy;
 
-		NamingStrategiesHibernatePropertiesCustomizer(PhysicalNamingStrategy physicalNamingStrategy,
-				ImplicitNamingStrategy implicitNamingStrategy) {
+		NamingStrategiesHibernatePropertiesCustomizer(@Nullable PhysicalNamingStrategy physicalNamingStrategy,
+				@Nullable ImplicitNamingStrategy implicitNamingStrategy) {
 			this.physicalNamingStrategy = physicalNamingStrategy;
 			this.implicitNamingStrategy = implicitNamingStrategy;
 		}
@@ -265,7 +266,7 @@ static class HibernateRuntimeHints implements RuntimeHintsRegistrar {
 			.builtWith(MemberCategory.INVOKE_DECLARED_CONSTRUCTORS);
 
 		@Override
-		public void registerHints(RuntimeHints hints, ClassLoader classLoader) {
+		public void registerHints(RuntimeHints hints, @Nullable ClassLoader classLoader) {
 			for (String noJtaPlatformClass : NO_JTA_PLATFORM_CLASSES) {
 				hints.reflection().registerType(TypeReference.of(noJtaPlatformClass), INVOKE_DECLARED_CONSTRUCTORS);
 			}

module/spring-boot-hibernate/src/main/java/org/springframework/boot/hibernate/autoconfigure/HibernateProperties.java

@@ -25,6 +25,7 @@
 import org.hibernate.cfg.MappingSettings;
 import org.hibernate.cfg.PersistenceSettings;
 import org.hibernate.cfg.SchemaToolingSettings;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.hibernate.SpringImplicitNamingStrategy;
@@ -54,13 +55,13 @@ public class HibernateProperties {
 	 * Defaults to "create-drop" when using an embedded database and no schema manager was
 	 * detected. Otherwise, defaults to "none".
 	 */
-	private String ddlAuto;
+	private @Nullable String ddlAuto;
 
-	public String getDdlAuto() {
+	public @Nullable String getDdlAuto() {
 		return this.ddlAuto;
 	}
 
-	public void setDdlAuto(String ddlAuto) {
+	public void setDdlAuto(@Nullable String ddlAuto) {
 		this.ddlAuto = ddlAuto;
 	}
 
@@ -107,7 +108,7 @@ private void applyScanner(Map<String, Object> result) {
 		}
 	}
 
-	private String determineDdlAuto(Map<String, String> existing, Supplier<String> defaultDdlAuto) {
+	private @Nullable String determineDdlAuto(Map<String, String> existing, Supplier<@Nullable String> defaultDdlAuto) {
 		String ddlAuto = existing.get(SchemaToolingSettings.HBM2DDL_AUTO);
 		if (ddlAuto != null) {
 			return ddlAuto;
@@ -126,26 +127,26 @@ public static class Naming {
 		/**
 		 * Fully qualified name of the implicit naming strategy.
 		 */
-		private String implicitStrategy;
+		private @Nullable String implicitStrategy;
 
 		/**
 		 * Fully qualified name of the physical naming strategy.
 		 */
-		private String physicalStrategy;
+		private @Nullable String physicalStrategy;
 
-		public String getImplicitStrategy() {
+		public @Nullable String getImplicitStrategy() {
 			return this.implicitStrategy;
 		}
 
-		public void setImplicitStrategy(String implicitStrategy) {
+		public void setImplicitStrategy(@Nullable String implicitStrategy) {
 			this.implicitStrategy = implicitStrategy;
 		}
 
-		public String getPhysicalStrategy() {
+		public @Nullable String getPhysicalStrategy() {
 			return this.physicalStrategy;
 		}
 
-		public void setPhysicalStrategy(String physicalStrategy) {
+		public void setPhysicalStrategy(@Nullable String physicalStrategy) {
 			this.physicalStrategy = physicalStrategy;
 		}
 
@@ -156,7 +157,7 @@ private void applyNamingStrategies(Map<String, Object> properties) {
 					PhysicalNamingStrategySnakeCaseImpl.class::getName);
 		}
 
-		private void applyNamingStrategy(Map<String, Object> properties, String key, Object strategy,
+		private void applyNamingStrategy(Map<String, Object> properties, String key, @Nullable Object strategy,
 				Supplier<String> defaultStrategy) {
 			if (strategy != null) {
 				properties.put(key, strategy);

module/spring-boot-hibernate/src/main/java/org/springframework/boot/hibernate/autoconfigure/HibernateSettings.java

@@ -20,6 +20,8 @@
 import java.util.Collection;
 import java.util.function.Supplier;
 
+import org.jspecify.annotations.Nullable;
+
 /**
  * Settings to apply when configuring Hibernate.
  *
@@ -28,16 +30,16 @@
  */
 public class HibernateSettings {
 
-	private Supplier<String> ddlAuto;
+	private @Nullable Supplier<String> ddlAuto;
 
-	private Collection<HibernatePropertiesCustomizer> hibernatePropertiesCustomizers;
+	private @Nullable Collection<HibernatePropertiesCustomizer> hibernatePropertiesCustomizers;
 
-	public HibernateSettings ddlAuto(Supplier<String> ddlAuto) {
+	public HibernateSettings ddlAuto(@Nullable Supplier<String> ddlAuto) {
 		this.ddlAuto = ddlAuto;
 		return this;
 	}
 
-	public String getDdlAuto() {
+	public @Nullable String getDdlAuto() {
 		return (this.ddlAuto != null) ? this.ddlAuto.get() : null;
 	}
 
@@ -47,7 +49,7 @@ public HibernateSettings hibernatePropertiesCustomizers(
 		return this;
 	}
 
-	public Collection<HibernatePropertiesCustomizer> getHibernatePropertiesCustomizers() {
+	public @Nullable Collection<HibernatePropertiesCustomizer> getHibernatePropertiesCustomizers() {
 		return this.hibernatePropertiesCustomizers;
 	}
 

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

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for JPA and Spring ORM.
  */
+@NullMarked
 package org.springframework.boot.hibernate.autoconfigure.metrics;
+
+import org.jspecify.annotations.NullMarked;

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

@@ -17,4 +17,7 @@
 /**
  * Auto-configuration for JPA and Spring ORM.
  */
+@NullMarked
 package org.springframework.boot.hibernate.autoconfigure;
+
+import org.jspecify.annotations.NullMarked;

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

@@ -17,4 +17,7 @@
 /**
  * Hibernate Support classes.
  */
+@NullMarked
 package org.springframework.boot.hibernate;
+
+import org.jspecify.annotations.NullMarked;