Skip to content

Commit 6e82427

Browse files
doljaewilkinsona
authored andcommitted
Clarify Javadoc of Customizer interfaces about overriding behavior
The previous wording suggested that customizations always retain default auto-configuration. Rephrased to indicate that configuration can be fine-tuned, which more accurately reflects that some builder methods may override or replace defaults. See gh-46938 Signed-off-by: Seokjae Lee <[email protected]>
1 parent 4679579 commit 6e82427

17 files changed

+24
-27
lines changed

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchConversionServiceCustomizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* Callback interface that can be implemented by beans wishing to customize the
2424
* {@link ConfigurableConversionService} that is
2525
* {@link DefaultBatchConfiguration#getConversionService provided by
26-
* DefaultBatchConfiguration} while retaining its default auto-configuration.
26+
* DefaultBatchConfiguration} to fine-tune its auto-configuration.
2727
*
2828
* @author Claudio Nave
2929
* @since 3.1.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CqlSessionBuilderCustomizer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121

2222
/**
2323
* Callback interface that can be implemented by beans wishing to customize the
24-
* {@link CqlSession} through a {@link CqlSessionBuilder} whilst retaining default
25-
* auto-configuration.
24+
* {@link CqlSession} through a {@link CqlSessionBuilder} to fine-tune
25+
* its auto-configuration.
2626
*
2727
* @author Stephane Nicoll
2828
* @since 2.3.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/DriverConfigLoaderBuilderCustomizer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121

2222
/**
2323
* Callback interface that can be implemented by beans wishing to customize the
24-
* {@link DriverConfigLoader} through a {@link DriverConfigLoaderBuilderCustomizer} whilst
25-
* retaining default auto-configuration.
24+
* {@link DriverConfigLoader} through a {@link DriverConfigLoaderBuilderCustomizer}
25+
* to fine-tune its auto-configuration.
2626
*
2727
* @author Stephane Nicoll
2828
* @since 2.3.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/ClusterEnvironmentBuilderCustomizer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121

2222
/**
2323
* Callback interface that can be implemented by beans wishing to customize the
24-
* {@link ClusterEnvironment} through a {@link Builder ClusterEnvironment.Builder} whilst
25-
* retaining default auto-configuration.
24+
* {@link ClusterEnvironment} through a {@link Builder ClusterEnvironment.Builder}
25+
* to fine-tune its auto-configuration.
2626
*
2727
* @author Stephane Nicoll
2828
* @since 2.3.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/ClientResourcesBuilderCustomizer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@
2121

2222
/**
2323
* Callback interface that can be implemented by beans wishing to customize the
24-
* {@link ClientResources} through a {@link Builder} whilst retaining default
25-
* auto-configuration.
24+
* {@link ClientResources} through a {@link Builder} to fine-tune its auto-configuration.
2625
*
2726
* @author Stephane Nicoll
2827
* @since 2.6.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/JedisClientConfigurationBuilderCustomizer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
/**
2323
* Callback interface that can be implemented by beans wishing to customize the
2424
* {@link JedisClientConfiguration} through a {@link JedisClientConfigurationBuilder
25-
* JedisClientConfiguration.JedisClientConfigurationBuilder} whilst retaining default
26-
* auto-configuration.
25+
* JedisClientConfiguration.JedisClientConfigurationBuilder} to fine-tune
26+
* its auto-configuration.
2727
*
2828
* @author Mark Paluch
2929
* @since 2.0.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientConfigurationBuilderCustomizer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
/**
2323
* Callback interface that can be implemented by beans wishing to customize the
2424
* {@link LettuceClientConfiguration} through a {@link LettuceClientConfigurationBuilder
25-
* LettuceClientConfiguration.LettuceClientConfigurationBuilder} whilst retaining default
26-
* auto-configuration. To customize only the
25+
* LettuceClientConfiguration.LettuceClientConfigurationBuilder} to fine-tune
26+
* its auto-configuration. To customize only the
2727
* {@link LettuceClientConfiguration#getClientOptions() client options} of the
2828
* configuration, use {@link LettuceClientOptionsBuilderCustomizer} instead.
2929
*

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/LettuceClientOptionsBuilderCustomizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* Callback interface that can be implemented by beans wishing to customize the
2626
* {@link ClientOptions} of the {@link LettuceClientConfiguration} through a
27-
* {@link Builder} whilst retaining default auto-configuration. To customize the entire
27+
* {@link Builder} to fine-tune its auto-configuration. To customize the entire
2828
* configuration, use {@link LettuceClientConfigurationBuilderCustomizer} instead.
2929
*
3030
* @author Soohyun Lim

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/graphql/GraphQlSourceBuilderCustomizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/**
2222
* Callback interface that can be implemented by beans wishing to customize properties of
2323
* {@link org.springframework.graphql.execution.GraphQlSource.SchemaResourceBuilder
24-
* Builder} whilst retaining default auto-configuration.
24+
* Builder} to fine-tune its auto-configuration.
2525
*
2626
* @author Rossen Stoyanchev
2727
* @since 2.7.0

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/gson/GsonBuilderCustomizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
/**
2323
* Callback interface that can be implemented by beans wishing to further customize the
24-
* {@link Gson} through {@link GsonBuilder} retaining its default auto-configuration.
24+
* {@link Gson} through {@link GsonBuilder} to fine-tune its auto-configuration.
2525
*
2626
* @author Ivan Golovko
2727
* @since 2.0.0

0 commit comments

Comments
 (0)