Polish "Clarify Javadoc of Customizer interfaces about overriding behavior"

See gh-46938
This commit is contained in:
Andy Wilkinson 2025-08-22 11:38:21 +01:00
parent 6e82427ffe
commit e595327610
25 changed files with 54 additions and 52 deletions

View File

@ -19,8 +19,8 @@ package org.springframework.boot.autoconfigure.amqp;
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

View File

@ -21,7 +21,8 @@ import com.rabbitmq.stream.EnvironmentBuilder;
/**
* 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

View File

@ -21,9 +21,9 @@ import org.springframework.core.convert.support.ConfigurableConversionService;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link ConfigurableConversionService} that is
* {@link DefaultBatchConfiguration#getConversionService provided by
* DefaultBatchConfiguration} to fine-tune its 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

View File

@ -21,8 +21,8 @@ import org.springframework.data.couchbase.cache.CouchbaseCacheManager.CouchbaseC
/**
* 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

View File

@ -21,8 +21,8 @@ import com.datastax.oss.driver.api.core.CqlSessionBuilder;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link CqlSession} through a {@link CqlSessionBuilder} to fine-tune
* its auto-configuration.
* {@link CqlSessionBuilder} to fine-tune its auto-configuration before it creates a
* {@link CqlSession}.
*
* @author Stephane Nicoll
* @since 2.3.0

View File

@ -21,8 +21,8 @@ import com.datastax.oss.driver.api.core.config.ProgrammaticDriverConfigLoaderBui
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link DriverConfigLoader} through a {@link DriverConfigLoaderBuilderCustomizer}
* to fine-tune its auto-configuration.
* {@link DriverConfigLoaderBuilderCustomizer} to fine-tune its auto-configuration before
* it creates a {@link DriverConfigLoader}.
*
* @author Stephane Nicoll
* @since 2.3.0

View File

@ -21,8 +21,8 @@ import com.couchbase.client.java.env.ClusterEnvironment.Builder;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link ClusterEnvironment} through a {@link Builder ClusterEnvironment.Builder}
* to fine-tune its 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

View File

@ -21,7 +21,8 @@ import io.lettuce.core.resource.ClientResources.Builder;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link ClientResources} through a {@link Builder} to fine-tune its auto-configuration.
* {@link Builder} to fine-tune its auto-configuration before it creates the
* {@link ClientResources}.
*
* @author Stephane Nicoll
* @since 2.6.0

View File

@ -21,9 +21,8 @@ import org.springframework.data.redis.connection.jedis.JedisClientConfiguration.
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link JedisClientConfiguration} through a {@link JedisClientConfigurationBuilder
* JedisClientConfiguration.JedisClientConfigurationBuilder} to fine-tune
* its auto-configuration.
* {@link JedisClientConfigurationBuilder} to fine-tune its auto-configuration before it
* creates the {@link JedisClientConfiguration}.
*
* @author Mark Paluch
* @since 2.0.0

View File

@ -21,9 +21,8 @@ import org.springframework.data.redis.connection.lettuce.LettuceClientConfigurat
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link LettuceClientConfiguration} through a {@link LettuceClientConfigurationBuilder
* LettuceClientConfiguration.LettuceClientConfigurationBuilder} to fine-tune
* its 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.
*

View File

@ -23,9 +23,9 @@ import org.springframework.data.redis.connection.lettuce.LettuceClientConfigurat
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link ClientOptions} of the {@link LettuceClientConfiguration} through a
* {@link Builder} to fine-tune its 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

View File

@ -23,8 +23,8 @@ import org.elasticsearch.client.RestClientBuilder;
/**
* 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

View File

@ -24,8 +24,9 @@ import org.springframework.ui.freemarker.FreeMarkerConfigurationFactory;
/**
* 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

View File

@ -20,8 +20,9 @@ import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
/**
* Callback interface that can be implemented by beans wishing to further customize the
* {@link Gson} through {@link GsonBuilder} to fine-tune its 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

View File

@ -22,8 +22,8 @@ import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
/**
* Callback interface that can be implemented by beans wishing to further customize the
* {@link ObjectMapper} through {@link Jackson2ObjectMapperBuilder} to fine-tune
* its auto-configuration.
* {@link ObjectMapper} through {@link Jackson2ObjectMapperBuilder} to fine-tune its
* auto-configuration.
*
* @author Grzegorz Poznachowski
* @since 1.4.0

View File

@ -21,8 +21,8 @@ import org.apache.activemq.artemis.core.server.embedded.EmbeddedActiveMQ;
/**
* 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

View File

@ -20,8 +20,8 @@ import com.mongodb.MongoClientSettings.Builder;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link com.mongodb.MongoClientSettings} through a {@link Builder
* MongoClientSettings.Builder} to fine-tune its 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

View File

@ -20,8 +20,9 @@ import org.neo4j.driver.Config;
import org.neo4j.driver.Config.ConfigBuilder;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link Config} through a {@link ConfigBuilder} to fine-tune its 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

View File

@ -19,8 +19,8 @@ package org.springframework.boot.autoconfigure.orm.jpa;
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

View File

@ -20,7 +20,8 @@ import java.util.Map;
/**
* 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

View File

@ -20,8 +20,7 @@ import org.springframework.pulsar.config.PulsarContainerFactory;
/**
* 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

View File

@ -22,8 +22,7 @@ import org.springframework.scheduling.quartz.SchedulerFactoryBean;
/**
* 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

View File

@ -21,8 +21,8 @@ import io.r2dbc.spi.ConnectionFactoryOptions.Builder;
/**
* Callback interface that can be implemented by beans wishing to customize the
* {@link ConnectionFactoryOptions} through a {@link Builder} to fine-tune
* its auto-configuration.
* {@link Builder} to fine-tune its auto-configuration before it creates a
* {@link ConnectionFactoryOptions}.
*
* @author Mark Paluch
* @since 2.3.0

View File

@ -19,8 +19,8 @@ package org.springframework.boot.autoconfigure.transaction;
import org.springframework.transaction.TransactionManager;
/**
* Callback interface that can be implemented by beans wishing to customize
* {@link TransactionManager TransactionManagers} to fine-tune its 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

View File

@ -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