Skip to content

Commit 3d57d36

Browse files
committed
Use fully-qualified names for ambiguous type references
Update type references to use a fully qualified name when we have more than one candidate available to us. See gh-41614
1 parent d289d0a commit 3d57d36

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+246
-245
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/actuator.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For more detail, see the javadoc:org.springframework.boot.actuate.autoconfigure.
2121
== Customizing Sanitization
2222

2323
To take control over the sanitization, define a `SanitizingFunction` bean.
24-
The `SanitizableData` with which the function is called provides access to the key and value as well as the `PropertySource` from which they came.
24+
The `SanitizableData` with which the function is called provides access to the key and value as well as the `org.springframework.core.env.PropertySource` from which they came.
2525
This allows you to, for example, sanitize every value that comes from a particular property source.
2626
Each `SanitizingFunction` is called in order until a function changes the value of the sanitizable data.
2727

@@ -30,7 +30,7 @@ Each `SanitizingFunction` is called in order until a function changes the value
3030
[[howto.actuator.map-health-indicators-to-metrics]]
3131
== Map Health Indicators to Micrometer Metrics
3232

33-
Spring Boot health indicators return a `Status` type to indicate the overall system health.
33+
Spring Boot health indicators return a `org.springframework.boot.actuate.health.Status` type to indicate the overall system health.
3434
If you want to monitor or alert on levels of health for a particular application, you can export these statuses as metrics with Micrometer.
3535
By default, the status codes "`UP`", "`DOWN`", "`OUT_OF_SERVICE`" and "`UNKNOWN`" are used by Spring Boot.
3636
To export these, you will need to convert these states to some set of numbers so that they can be used with a Micrometer `Gauge`.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/batch.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ If you do so and want two transaction managers, remember to mark the other one a
3434

3535
Spring Batch auto-configuration is enabled by adding `spring-boot-starter-batch` to your application's classpath.
3636

37-
If a single `Job` bean is found in the application context, it is executed on startup (see javadoc:org.springframework.boot.autoconfigure.batch.JobLauncherApplicationRunner[] for details).
38-
If multiple `Job` beans are found, the job that should be executed must be specified using configprop:spring.batch.job.name[].
37+
If a single `org.springframework.batch.core.Job` bean is found in the application context, it is executed on startup (see javadoc:org.springframework.boot.autoconfigure.batch.JobLauncherApplicationRunner[] for details).
38+
If multiple `org.springframework.batch.core.Job` beans are found, the job that should be executed must be specified using configprop:spring.batch.job.name[].
3939

40-
To disable running a `Job` found in the application context, set the configprop:spring.batch.job.enabled[] to `false`.
40+
To disable running a `org.springframework.batch.core.Job` found in the application context, set the configprop:spring.batch.job.enabled[] to `false`.
4141

4242
See {code-spring-boot-autoconfigure-src}/batch/BatchAutoConfiguration.java[`BatchAutoConfiguration`] for more details.
4343

@@ -70,7 +70,7 @@ This provides only one argument to the batch job: `someParameter=someValue`.
7070
[[howto.batch.restarting-a-failed-job]]
7171
== Restarting a Stopped or Failed Job
7272

73-
To restart a failed `Job`, all parameters (identifying and non-identifying) must be re-specified on the command line.
73+
To restart a failed `org.springframework.batch.core.Job`, all parameters (identifying and non-identifying) must be re-specified on the command line.
7474
Non-identifying parameters are *not* copied from the previous execution.
7575
This allows them to be modified or removed.
7676

@@ -81,6 +81,6 @@ NOTE: When you're using a custom `JobParametersIncrementer`, you have to gather
8181
[[howto.batch.storing-job-repository]]
8282
== Storing the Job Repository
8383

84-
Spring Batch requires a data store for the `Job` repository.
84+
Spring Batch requires a data store for the `org.springframework.batch.core.Job` repository.
8585
If you use Spring Boot, you must use an actual database.
8686
Note that it can be an in-memory database, see {url-spring-batch-docs}/job.html#configuringJobRepository[Configuring a Job Repository].

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/build.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Both the Maven and Gradle plugins allow the properties that are included in `git
8383

8484
TIP: The commit time in `git.properties` is expected to match the following format: `yyyy-MM-dd'T'HH:mm:ssZ`.
8585
This is the default format for both plugins listed above.
86-
Using this format lets the time be parsed into a `Date` and its format, when serialized to JSON, to be controlled by Jackson's date serialization configuration settings.
86+
Using this format lets the time be parsed into a `java.util.Date` and its format, when serialized to JSON, to be controlled by Jackson's date serialization configuration settings.
8787

8888

8989

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -157,14 +157,14 @@ See xref:reference:data/sql.adoc#data.sql.datasource.connection-pool[] for detai
157157
[[howto.data-access.spring-data-repositories]]
158158
== Use Spring Data Repositories
159159

160-
Spring Data can create implementations of `Repository` interfaces of various flavors.
161-
Spring Boot handles all of that for you, as long as those `Repository` implementations are included in one of the xref:reference:using/auto-configuration.adoc#using.auto-configuration.packages[auto-configuration packages], typically the package (or a sub-package) of your main application class that is annotated with `@SpringBootApplication` or `@EnableAutoConfiguration`.
160+
Spring Data can create implementations of `org.springframework.data.repository.Repository` interfaces of various flavors.
161+
Spring Boot handles all of that for you, as long as those `org.springframework.data.repository.Repository` implementations are included in one of the xref:reference:using/auto-configuration.adoc#using.auto-configuration.packages[auto-configuration packages], typically the package (or a sub-package) of your main application class that is annotated with `@SpringBootApplication` or `@EnableAutoConfiguration`.
162162

163163
For many applications, all you need is to put the right Spring Data dependencies on your classpath.
164164
There is a `spring-boot-starter-data-jpa` for JPA, `spring-boot-starter-data-mongodb` for Mongodb, and various other starters for supported technologies.
165165
To get started, create some repository interfaces to handle your `@Entity` objects.
166166

167-
Spring Boot determines the location of your `Repository` implementations by scanning the xref:reference:using/auto-configuration.adoc#using.auto-configuration.packages[auto-configuration packages].
167+
Spring Boot determines the location of your `org.springframework.data.repository.Repository` implementations by scanning the xref:reference:using/auto-configuration.adoc#using.auto-configuration.packages[auto-configuration packages].
168168
For more control, use the `@Enable…Repositories` annotations from Spring Data.
169169

170170
For more about Spring Data, see the {url-spring-data-site}[Spring Data project page].
@@ -278,8 +278,8 @@ Then, add a `HibernatePropertiesCustomizer` bean as shown in the following examp
278278

279279
include-code::MyHibernateSecondLevelCacheConfiguration[]
280280

281-
This customizer will configure Hibernate to use the same `CacheManager` as the one that the application uses.
282-
It is also possible to use separate `CacheManager` instances.
281+
This customizer will configure Hibernate to use the same `org.springframework.cache.CacheManager` as the one that the application uses.
282+
It is also possible to use separate `org.springframework.cache.CacheManager` instances.
283283
For details, see {url-hibernate-userguide}#caching-provider-jcache[the Hibernate user guide].
284284

285285

@@ -343,9 +343,9 @@ See {code-spring-boot-autoconfigure-src}/orm/jpa/JpaBaseConfiguration.java[`JpaB
343343
[[howto.data-access.use-spring-data-jpa-and-mongo-repositories]]
344344
== Use Spring Data JPA and Mongo Repositories
345345

346-
Spring Data JPA and Spring Data Mongo can both automatically create `Repository` implementations for you.
346+
Spring Data JPA and Spring Data Mongo can both automatically create `org.springframework.data.repository.Repository` implementations for you.
347347
If they are both present on the classpath, you might have to do some extra configuration to tell Spring Boot which repositories to create.
348-
The most explicit way to do that is to use the standard Spring Data `@EnableJpaRepositories` and `@EnableMongoRepositories` annotations and provide the location of your `Repository` interfaces.
348+
The most explicit way to do that is to use the standard Spring Data `@EnableJpaRepositories` and `@EnableMongoRepositories` annotations and provide the location of your `org.springframework.data.repository.Repository` interfaces.
349349

350350
There are also flags (`+spring.data.*.repositories.enabled+` and `+spring.data.*.repositories.type+`) that you can use to switch the auto-configured repositories on and off in external configuration.
351351
Doing so is useful, for instance, in case you want to switch off the Mongo repositories and still use the auto-configured `MongoTemplate`.
@@ -367,7 +367,7 @@ Note that if you are using Spring Data REST, you must use the properties in the
367367
[[howto.data-access.exposing-spring-data-repositories-as-rest]]
368368
== Expose Spring Data Repositories as REST Endpoint
369369

370-
Spring Data REST can expose the `Repository` implementations as REST endpoints for you,
370+
Spring Data REST can expose the `org.springframework.data.repository.Repository` implementations as REST endpoints for you,
371371
provided Spring MVC has been enabled for the application.
372372

373373
Spring Boot exposes a set of useful properties (from the `spring.data.rest` namespace) that customize the javadoc:{url-spring-data-rest-javadoc}/org.springframework.data.rest.core.config.RepositoryRestConfiguration[].

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-initialization.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It is recommended to use a single mechanism for schema generation.
1313
You can set configprop:spring.jpa.hibernate.ddl-auto[] to control Hibernate's database initialization.
1414
Supported values are `none`, `validate`, `update`, `create`, and `create-drop`.
1515
Spring Boot chooses a default value for you based on whether you are using an embedded database.
16-
An embedded database is identified by looking at the `Connection` type and JDBC url.
16+
An embedded database is identified by looking at the `java.sql.Connection` type and JDBC url.
1717
`hsqldb`, `h2`, or `derby` are embedded databases and others are not.
1818
If an embedded database is identified and no schema manager (Flyway or Liquibase) has been detected, `ddl-auto` defaults to `create-drop`.
1919
In all other cases, it defaults to `none`.
@@ -33,7 +33,7 @@ It is a Hibernate feature (and has nothing to do with Spring).
3333
[[howto.data-initialization.using-basic-sql-scripts]]
3434
== Initialize a Database Using Basic SQL Scripts
3535

36-
Spring Boot can automatically create the schema (DDL scripts) of your JDBC `DataSource` or R2DBC `ConnectionFactory` and initialize its data (DML scripts).
36+
Spring Boot can automatically create the schema (DDL scripts) of your JDBC `DataSource` or R2DBC `io.r2dbc.spi.ConnectionFactory` and initialize its data (DML scripts).
3737

3838
By default, it loads schema scripts from `optional:classpath*:schema.sql` and data scripts from `optional:classpath*:data.sql`.
3939
The locations of these schema and data scripts can be customized using configprop:spring.sql.init.schema-locations[] and configprop:spring.sql.init.data-locations[] respectively.
@@ -139,9 +139,9 @@ If you would like more control, provide a `@Bean` that implements javadoc:org.sp
139139

140140
Flyway supports SQL and Java https://documentation.red-gate.com/fd/callback-concept-184127466.html[callbacks].
141141
To use SQL-based callbacks, place the callback scripts in the `classpath:db/migration` directory.
142-
To use Java-based callbacks, create one or more beans that implement `Callback`.
142+
To use Java-based callbacks, create one or more beans that implement `org.flywaydb.core.api.callback.Callback`.
143143
Any such beans are automatically registered with `Flyway`.
144-
They can be ordered by using `@Order` or by implementing `Ordered`.
144+
They can be ordered by using `@org.springframework.core.annotation.Order` or by implementing `org.springframework.core.Ordered`.
145145

146146
By default, Flyway autowires the (`@Primary`) `DataSource` in your context and uses that for migrations.
147147
If you like to use a different `DataSource`, you can create one and mark its `@Bean` as `@FlywayDataSource`.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/traditional-deployment.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ If you have other features in your application (for instance, using other servle
9191

9292
* A `@Bean` of type `Servlet` or `ServletRegistrationBean` installs that bean in the container as if it were a `<servlet/>` and `<servlet-mapping/>` in `web.xml`.
9393
* A `@Bean` of type `Filter` or `FilterRegistrationBean` behaves similarly (as a `<filter/>` and `<filter-mapping/>`).
94-
* An `ApplicationContext` in an XML file can be added through an `@ImportResource` in your `Application`.
94+
* An `ApplicationContext` in an XML file can be added through an `@ImportResource` in your `+Application+`.
9595
Alternatively, cases where annotation configuration is heavily used already can be recreated in a few lines as `@Bean` definitions.
9696

9797
Once the war file is working, you can make it executable by adding a `main` method to your `+Application+`, as shown in the following example:

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/http-clients.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The exact details of the proxy configuration depend on the underlying client req
2121

2222
When Reactor Netty is on the classpath a Reactor Netty-based `WebClient` is auto-configured.
2323
To customize the client's handling of network connections, provide a `ClientHttpConnector` bean.
24-
The following example configures a 60 second connect timeout and adds a `ReadTimeoutHandler`:
24+
The following example configures a 60 second connect timeout and adds a `io.netty.handler.timeout.ReadTimeoutHandler`:
2525

2626
include-code::MyReactorNettyClientConfiguration[]
2727

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/jersey.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Spring Security can be used to secure a Jersey-based web application in much the
1010
However, if you want to use Spring Security's method-level security with Jersey, you must configure Jersey to use `setStatus(int)` rather `sendError(int)`.
1111
This prevents Jersey from committing the response before Spring Security has had an opportunity to report an authentication or authorization failure to the client.
1212

13-
The `jersey.config.server.response.setStatusOverSendError` property must be set to `true` on the application's `ResourceConfig` bean, as shown in the following example:
13+
The `jersey.config.server.response.setStatusOverSendError` property must be set to `true` on the application's `org.glassfish.jersey.server.ResourceConfig` bean, as shown in the following example:
1414

1515
include-code::JerseySetStatusOverSendErrorConfig[]
1616

@@ -21,6 +21,6 @@ include-code::JerseySetStatusOverSendErrorConfig[]
2121

2222
To use Jersey alongside another web framework, such as Spring MVC, it should be configured so that it will allow the other framework to handle requests that it cannot handle.
2323
First, configure Jersey to use a filter rather than a servlet by configuring the configprop:spring.jersey.type[] application property with a value of `filter`.
24-
Second, configure your `ResourceConfig` to forward requests that would have resulted in a 404, as shown in the following example.
24+
Second, configure your `org.glassfish.jersey.server.ResourceConfig` to forward requests that would have resulted in a 404, as shown in the following example.
2525

2626
include-code::JerseyConfig[]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/logging.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ These includes are designed to allow certain common Spring Boot conventions to b
5050
The following files are provided under `org/springframework/boot/logging/logback/`:
5151

5252
* `defaults.xml` - Provides conversion rules, pattern properties and common logger configurations.
53-
* `console-appender.xml` - Adds a `ConsoleAppender` using the `CONSOLE_LOG_PATTERN`.
54-
* `file-appender.xml` - Adds a `RollingFileAppender` using the `FILE_LOG_PATTERN` and `ROLLING_FILE_NAME_PATTERN` with appropriate settings.
53+
* `console-appender.xml` - Adds a `ch.qos.logback.core.ConsoleAppender` using the `CONSOLE_LOG_PATTERN`.
54+
* `file-appender.xml` - Adds a `ch.qos.logback.core.rolling.RollingFileAppender` using the `FILE_LOG_PATTERN` and `ROLLING_FILE_NAME_PATTERN` with appropriate settings.
5555

5656
In addition, a legacy `base.xml` file is provided for compatibility with earlier versions of Spring Boot.
5757

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/security.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you define a `@Configuration` with a `SecurityFilterChain` bean in your appli
1717
[[howto.security.change-user-details-service-and-add-user-accounts]]
1818
== Change the UserDetailsService and Add User Accounts
1919

20-
If you provide a `@Bean` of type `AuthenticationManager`, `AuthenticationProvider`, or `UserDetailsService`, the default `@Bean` for `InMemoryUserDetailsManager` is not created.
20+
If you provide a `@Bean` of type `AuthenticationManager`, `org.springframework.security.authentication.AuthenticationProvider`, or `UserDetailsService`, the default `@Bean` for `InMemoryUserDetailsManager` is not created.
2121
This means you have the full feature set of Spring Security available (such as {url-spring-security-docs}/servlet/authentication/index.html[various authentication options]).
2222

2323
The easiest way to add user accounts is by providing your own `UserDetailsService` bean.

0 commit comments

Comments
 (0)