Merge pull request #46938 from doljae

wilkinsona · wilkinsona · commit b7282c00ae9a · 2025-08-22T11:40:41.000+01:00
* gh-46938: Polish "Clarify Javadoc of Customizer interfaces about overriding behavior" Clarify Javadoc of Customizer interfaces about overriding behavior Closes gh-46938
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/ConnectionFactoryCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/ConnectionFactoryCustomizer.java
@@ -19,8 +19,8 @@
 import com.rabbitmq.client.ConnectionFactory;
 
 /**
- * Callback interface that can be implemented by beans wishing to customize the
- * auto-configured RabbitMQ {@link ConnectionFactory}.
+ * Callback interface that can be implemented by beans wishing to customize the RabbitMQ
+ * {@link ConnectionFactory} to fine-tune its auto-configuration.
  *
  * @author Andy Wilkinson
  * @since 2.5.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/EnvironmentBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/EnvironmentBuilderCustomizer.java
@@ -21,7 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * auto-configured {@link Environment} that is created by an {@link EnvironmentBuilder}.
+ * {@link EnvironmentBuilder} to fine-tune its auto-configuration before it creates an
+ * {@link Environment}.
  *
  * @author Andy Wilkinson
  * @since 3.0.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchConversionServiceCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchConversionServiceCustomizer.java
@@ -21,9 +21,9 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ConfigurableConversionService} that is
- * {@link DefaultBatchConfiguration#getConversionService provided by
- * DefaultBatchConfiguration} while retaining its default auto-configuration.
+ * {@link ConfigurableConversionService} to fine-tune its auto-configuration. The
+ * conversion service is {@link DefaultBatchConfiguration#getConversionService provided by
+ * DefaultBatchConfiguration}.
  *
  * @author Claudio Nave
  * @since 3.1.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CouchbaseCacheManagerBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CouchbaseCacheManagerBuilderCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link CouchbaseCacheManagerBuilder} before it is used to build the auto-configured
- * {@link CouchbaseCacheManager}.
+ * {@link CouchbaseCacheManagerBuilder} to fine-tune its auto-configuration before it is
+ * used to build the auto-configured {@link CouchbaseCacheManager}.
  *
  * @author Stephane Nicoll
  * @since 2.3.3
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CqlSessionBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CqlSessionBuilderCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link CqlSession} through a {@link CqlSessionBuilder} whilst retaining default
- * auto-configuration.
+ * {@link CqlSessionBuilder} to fine-tune its auto-configuration before it creates a
+ * {@link CqlSession}.
  *
  * @author Stephane Nicoll
  * @since 2.3.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/DriverConfigLoaderBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/DriverConfigLoaderBuilderCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link DriverConfigLoader} through a {@link DriverConfigLoaderBuilderCustomizer} whilst
- * retaining default auto-configuration.
+ * {@link DriverConfigLoaderBuilderCustomizer} to fine-tune its auto-configuration before
+ * it creates a {@link DriverConfigLoader}.
  *
  * @author Stephane Nicoll
  * @since 2.3.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/ClusterEnvironmentBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/ClusterEnvironmentBuilderCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ClusterEnvironment} through a {@link Builder ClusterEnvironment.Builder} whilst
- * retaining default auto-configuration.
+ * {@link Builder ClusterEnvironment.Builder} to fine-tune its auto-configuration before
+ * it creates the {@link ClusterEnvironment}.
  *
  * @author Stephane Nicoll
  * @since 2.3.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/ClientResourcesBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/ClientResourcesBuilderCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ClientResources} through a {@link Builder} whilst retaining default
- * auto-configuration.
+ * {@link Builder} to fine-tune its auto-configuration before it creates the
+ * {@link ClientResources}.
  *
  * @author Stephane Nicoll
  * @since 2.6.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/JedisClientConfigurationBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/JedisClientConfigurationBuilderCustomizer.java
@@ -21,9 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link JedisClientConfiguration} through a {@link JedisClientConfigurationBuilder
- * JedisClientConfiguration.JedisClientConfigurationBuilder} whilst retaining default
- * auto-configuration.
+ * {@link JedisClientConfigurationBuilder} to fine-tune its auto-configuration before it
+ * creates the {@link JedisClientConfiguration}.
  *
  * @author Mark Paluch
  * @since 2.0.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientConfigurationBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientConfigurationBuilderCustomizer.java
@@ -21,9 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link LettuceClientConfiguration} through a {@link LettuceClientConfigurationBuilder
- * LettuceClientConfiguration.LettuceClientConfigurationBuilder} whilst retaining default
- * auto-configuration. To customize only the
+ * {@link LettuceClientConfigurationBuilder} to fine-tune its auto-configuration before it
+ * creates the {@link LettuceClientConfiguration}. To customize only the
  * {@link LettuceClientConfiguration#getClientOptions() client options} of the
  * configuration, use {@link LettuceClientOptionsBuilderCustomizer} instead.
  *
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientOptionsBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientOptionsBuilderCustomizer.java
@@ -23,9 +23,9 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ClientOptions} of the {@link LettuceClientConfiguration} through a
- * {@link Builder} whilst retaining default auto-configuration. To customize the entire
- * configuration, use {@link LettuceClientConfigurationBuilderCustomizer} instead.
+ * {@link Builder} to fine-tune its auto-configuration before it creates the
+ * {@link ClientOptions} of the {@link LettuceClientConfiguration}. To customize the
+ * entire configuration, use {@link LettuceClientConfigurationBuilderCustomizer} instead.
  *
  * @author Soohyun Lim
  * @since 3.4.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/RestClientBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/RestClientBuilderCustomizer.java
@@ -23,8 +23,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to further customize the
- * {@link org.elasticsearch.client.RestClient} through a {@link RestClientBuilder} whilst
- * retaining default auto-configuration.
+ * {@link RestClientBuilder} to fine-tune its auto-configuration before it creates the
+ * {@link org.elasticsearch.client.RestClient}.
  *
  * @author Brian Clozel
  * @author Vedran Pavic
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerVariablesCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerVariablesCustomizer.java
@@ -24,8 +24,9 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the FreeMarker
- * variables used as {@link Configuration#getSharedVariableNames() shared variables}
- * before it is used by an auto-configured {@link FreeMarkerConfigurationFactory}.
+ * {@link Configuration#getSharedVariableNames() shared variables} to fine-tune their
+ * auto-configuration before they are used by an auto-configured
+ * {@link FreeMarkerConfigurationFactory}.
  *
  * @author Stephane Nicoll
  * @since 3.4.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/graphql/GraphQlSourceBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/graphql/GraphQlSourceBuilderCustomizer.java
@@ -21,7 +21,7 @@
 /**
  * Callback interface that can be implemented by beans wishing to customize properties of
  * {@link org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
- * Builder} whilst retaining default auto-configuration.
+ * Builder} to fine-tune its auto-configuration.
  *
  * @author Rossen Stoyanchev
  * @since 2.7.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/gson/GsonBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/gson/GsonBuilderCustomizer.java
@@ -20,8 +20,9 @@
 import com.google.gson.GsonBuilder;
 
 /**
- * Callback interface that can be implemented by beans wishing to further customize the
- * {@link Gson} through {@link GsonBuilder} retaining its default auto-configuration.
+ * Callback interface that can be implemented by beans wishing to customize the
+ * {@link GsonBuilder} to fine-tune its auto-configuration before it creates a
+ * {@link Gson} instance.
  *
  * @author Ivan Golovko
  * @since 2.0.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/Jackson2ObjectMapperBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/Jackson2ObjectMapperBuilderCustomizer.java
@@ -22,7 +22,7 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to further customize the
- * {@link ObjectMapper} through {@link Jackson2ObjectMapperBuilder} retaining its default
+ * {@link ObjectMapper} through {@link Jackson2ObjectMapperBuilder} to fine-tune its
  * auto-configuration.
  *
  * @author Grzegorz Poznachowski
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQConnectionFactoryCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQConnectionFactoryCustomizer.java
@@ -20,7 +20,7 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ActiveMQConnectionFactory} whilst retaining default auto-configuration.
+ * {@link ActiveMQConnectionFactory} to fine-tune its auto-configuration.
  *
  * @author Stephane Nicoll
  * @since 3.1.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisConfigurationCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisConfigurationCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the Artemis
- * JMS server {@link Configuration} before it is used by an auto-configured
- * {@link EmbeddedActiveMQ} instance.
+ * JMS server {@link Configuration} to fine-tune its auto-configuration before it is used
+ * by the auto-configured {@link EmbeddedActiveMQ} instance.
  *
  * @author Eddú Meléndez
  * @author Phillip Webb
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/DefaultConfigurationCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/DefaultConfigurationCustomizer.java
@@ -20,7 +20,7 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link DefaultConfiguration} whilst retaining default auto-configuration.
+ * {@link DefaultConfiguration} to fine-tune its auto-configuration.
  *
  * @author Stephane Nicoll
  * @since 2.5.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoClientSettingsBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoClientSettingsBuilderCustomizer.java
@@ -20,8 +20,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link com.mongodb.MongoClientSettings} through a {@link Builder
- * MongoClientSettings.Builder} whilst retaining default auto-configuration.
+ * {@link Builder MongoClientSettings.Builder} to fine-tune its auto-configuration. before
+ * it creates a {@link com.mongodb.MongoClientSettings}.
  *
  * @author Mark Paluch
  * @since 2.0.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/neo4j/ConfigBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/neo4j/ConfigBuilderCustomizer.java
@@ -20,9 +20,9 @@
 import org.neo4j.driver.Config.ConfigBuilder;
 
 /**
- * Callback interface that can be implemented by beans wishing to customize the
- * {@link Config} through a {@link ConfigBuilder} whilst retaining default
- * auto-configuration.
+ * Callback interface that can be implemented by beans wishing to customize the a
+ * {@link ConfigBuilder} to fine-tune its auto-configuration before it creates a
+ * {@link Config} instance.
  *
  * @author Stephane Nicoll
  * @since 2.4.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/EntityManagerFactoryBuilderCustomizer.java
@@ -19,8 +19,8 @@
 import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
 
 /**
- * Callback interface that can be used to customize the auto-configured
- * {@link EntityManagerFactoryBuilder}.
+ * Callback interface that can be used to customize the
+ * {@link EntityManagerFactoryBuilder} to fine-tune its auto-configuration.
  *
  * @author Andy Wilkinson
  * @since 2.1.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/HibernatePropertiesCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/HibernatePropertiesCustomizer.java
@@ -20,7 +20,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the Hibernate
- * properties before it is used by an auto-configured {@code EntityManagerFactory}.
+ * properties to customize their auto-configuration prior to use by the auto-configured
+ * {@code EntityManagerFactory}.
  *
  * @author Stephane Nicoll
  * @since 2.0.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/pulsar/PulsarContainerFactoryCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/pulsar/PulsarContainerFactoryCustomizer.java
@@ -20,8 +20,7 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize a
- * {@link PulsarContainerFactory} before it is fully initialized, in particular to tune
- * its configuration.
+ * {@link PulsarContainerFactory} to fine-tune its auto-configuration.
  *
  * @param <T> the type of the {@link PulsarContainerFactory}
  * @author Chris Bono
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/SchedulerFactoryBeanCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/quartz/SchedulerFactoryBeanCustomizer.java
@@ -22,8 +22,7 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the Quartz
- * {@link SchedulerFactoryBean} before it is fully initialized, in particular to tune its
- * configuration.
+ * {@link SchedulerFactoryBean} to fine-tune its auto-configuration.
  * <p>
  * For customization of the {@link DataSource} used by Quartz, use of
  * {@link QuartzDataSource @QuartzDataSource} is preferred. It will ensure consistent
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/r2dbc/ConnectionFactoryOptionsBuilderCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/r2dbc/ConnectionFactoryOptionsBuilderCustomizer.java
@@ -21,8 +21,8 @@
 
 /**
  * Callback interface that can be implemented by beans wishing to customize the
- * {@link ConnectionFactoryOptions} through a {@link Builder} whilst retaining default
- * auto-configuration.
+ * {@link Builder} to fine-tune its auto-configuration before it creates a
+ * {@link ConnectionFactoryOptions}.
  *
  * @author Mark Paluch
  * @since 2.3.0
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionManagerCustomizer.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionManagerCustomizer.java
@@ -19,9 +19,8 @@
 import org.springframework.transaction.TransactionManager;
 
 /**
- * Callback interface that can be implemented by beans wishing to customize
- * {@link TransactionManager TransactionManagers} while retaining default
- * auto-configuration.
+ * Callback interface that can be implemented by beans wishing to customize a
+ * {@link TransactionManager} to fine-tune its auto-configuration.
  *
  * @param <T> the transaction manager type
  * @author Andy Wilkinson
diff --git a/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/reactive/server/WebTestClientBuilderCustomizer.java b/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test/web/reactive/server/WebTestClientBuilderCustomizer.java
@@ -16,12 +16,12 @@
 
 package org.springframework.boot.test.web.reactive.server;
 
+import org.springframework.test.web.reactive.server.WebTestClient;
 import org.springframework.test.web.reactive.server.WebTestClient.Builder;
 
 /**
- * A customizer for a {@link Builder}. Any {@code WebTestClientBuilderCustomizer} beans
- * found in the application context will be {@link #customize called} to customize the
- * auto-configured {@link Builder}.
+ * A customizer that can be implemented by beans wishing to customize the {@link Builder}
+ * to fine-tine its auto-configuration before a {@link WebTestClient} is created.
  *
  * @author Andy Wilkinson
  * @since 2.2.0

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@`
`21`	`21`
`22`	`22`	`/**`
`23`	`23`	`* Callback interface that can be implemented by beans wishing to customize the`
`24`		`- * auto-configured {@link Environment} that is created by an {@link EnvironmentBuilder}.`
	`24`	`+ * {@link EnvironmentBuilder} to fine-tune its auto-configuration before it creates an`
	`25`	`+ * {@link Environment}.`
`25`	`26`	`*`
`26`	`27`	`* @author Andy Wilkinson`
`27`	`28`	`* @since 3.0.0`