From 15862327617a86ae771b2dd2844a46b36f8a6e6a Mon Sep 17 00:00:00 2001 From: Leo Li <269739606@qq.com> Date: Fri, 15 Oct 2021 16:28:22 +0800 Subject: [PATCH 1/2] Polish See gh-28367 --- .../web/annotation/ControllerEndpoint.java | 6 +++--- .../web/annotation/RestControllerEndpoint.java | 6 +++--- .../boot/actuate/trace/http/TraceableRequest.java | 4 ++-- .../boot/actuate/metrics/MetricsEndpointTests.java | 4 ++-- .../autoconfigure/condition/ConditionalOnBean.java | 4 ++-- .../condition/ConditionalOnMissingBean.java | 4 ++-- .../condition/ConditionalOnProperty.java | 4 ++-- .../condition/ConditionalOnSingleCandidate.java | 4 ++-- .../jmx/ParentAwareNamingStrategy.java | 5 +++-- .../security/saml2/Saml2LoginConfiguration.java | 6 +++--- .../saml2/Saml2RelyingPartyProperties.java | 14 +++++++------- ...Saml2RelyingPartyRegistrationConfiguration.java | 2 +- .../MultiDataSourceUsingPrimaryConfiguration.java | 2 +- 13 files changed, 33 insertions(+), 32 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/ControllerEndpoint.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/ControllerEndpoint.java index fbee3d99e0..dee548086e 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/ControllerEndpoint.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/ControllerEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,8 +35,8 @@ import org.springframework.web.bind.annotation.PostMapping; /** * Identifies a type as being an endpoint that is only exposed over Spring MVC or Spring * WebFlux. Mapped methods must be annotated with {@link GetMapping @GetMapping}, - * {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc annotations - * rather than {@link ReadOperation @ReadOperation}, + * {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc. + * annotations rather than {@link ReadOperation @ReadOperation}, * {@link WriteOperation @WriteOperation}, {@link DeleteOperation @DeleteOperation}. *
* This annotation can be used when deeper Spring integration is required, but at the diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/RestControllerEndpoint.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/RestControllerEndpoint.java index 15f5fee332..0aec498c54 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/RestControllerEndpoint.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/web/annotation/RestControllerEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,8 +36,8 @@ import org.springframework.web.bind.annotation.ResponseBody; /** * Identifies a type as being a REST endpoint that is only exposed over Spring MVC or * Spring WebFlux. Mapped methods must be annotated with {@link GetMapping @GetMapping}, - * {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc annotations - * rather than {@link ReadOperation @ReadOperation}, + * {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc. + * annotations rather than {@link ReadOperation @ReadOperation}, * {@link WriteOperation @WriteOperation}, {@link DeleteOperation @DeleteOperation}. *
* This annotation can be used when deeper Spring integration is required, but at the diff --git a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/http/TraceableRequest.java b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/http/TraceableRequest.java index 16257e6ee7..4dbe55a23c 100644 --- a/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/http/TraceableRequest.java +++ b/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/trace/http/TraceableRequest.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -30,7 +30,7 @@ import java.util.Map; public interface TraceableRequest { /** - * Returns the method (GET, POST, etc) of the request. + * Returns the method (GET, POST, etc.) of the request. * @return the method */ String getMethod(); diff --git a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/MetricsEndpointTests.java b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/MetricsEndpointTests.java index ef5e128999..9413ce6804 100644 --- a/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/MetricsEndpointTests.java +++ b/spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/MetricsEndpointTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2020 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -67,7 +67,7 @@ class MetricsEndpointTests { } @Test - void listNamesRecursesOverCompositeRegistries() { + void listNamesResponseOverCompositeRegistries() { CompositeMeterRegistry composite = new CompositeMeterRegistry(); SimpleMeterRegistry reg1 = new SimpleMeterRegistry(); SimpleMeterRegistry reg2 = new SimpleMeterRegistry(); diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java index 5985cce4ce..b5a97bea6a 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnBean.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,7 +51,7 @@ import org.springframework.context.annotation.Conditional; * already contained in the {@link BeanFactory}. *
* The condition can only match the bean definitions that have been processed by the - * application context so far and, as such, it is strongly recommended to use this + * application context so far and, as such, it is strongly recommended using this * condition on auto-configuration classes only. If a candidate bean may be created by * another auto-configuration, make sure that the one using this condition runs after. * diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java index e7acf5deae..6a473743dc 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,7 +51,7 @@ import org.springframework.context.annotation.Conditional; * already contained in the {@link BeanFactory}. *
* The condition can only match the bean definitions that have been processed by the - * application context so far and, as such, it is strongly recommended to use this + * application context so far and, as such, it is strongly recommended using this * condition on auto-configuration classes only. If a candidate bean may be created by * another auto-configuration, make sure that the one using this condition runs after. * diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java index aa7f5b8c6e..a4b8f947b5 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnProperty.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -131,7 +131,7 @@ public @interface ConditionalOnProperty { /** * Specify if the condition should match if the property is not set. Defaults to * {@code false}. - * @return if should match if the property is missing + * @return if the condition should match if the property is missing */ boolean matchIfMissing() default false; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java index b077dcee2c..2d2ce2874c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2019 the original author or authors. + * Copyright 2012-2021 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,7 +35,7 @@ import org.springframework.context.annotation.Conditional; * condition match if auto-wiring a bean with the defined type will succeed. *
* The condition can only match the bean definitions that have been processed by the
- * application context so far and, as such, it is strongly recommended to use this
+ * application context so far and, as such, it is strongly recommended using this
* condition on auto-configuration classes only. If a candidate bean may be created by
* another auto-configuration, make sure that the one using this condition runs after.
*
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/ParentAwareNamingStrategy.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/ParentAwareNamingStrategy.java
index 492ca6e119..da8781f7a2 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/ParentAwareNamingStrategy.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/ParentAwareNamingStrategy.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,7 +48,8 @@ public class ParentAwareNamingStrategy extends MetadataNamingStrategy implements
/**
* Set if unique runtime object names should be ensured.
- * @param ensureUniqueRuntimeObjectNames {@code true} if unique names should ensured.
+ * @param ensureUniqueRuntimeObjectNames {@code true} if unique names should be
+ * ensured.
*/
public void setEnsureUniqueRuntimeObjectNames(boolean ensureUniqueRuntimeObjectNames) {
this.ensureUniqueRuntimeObjectNames = ensureUniqueRuntimeObjectNames;
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java
index 0c73e5fe54..b74eea2cd1 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -26,8 +26,8 @@ import org.springframework.security.saml2.provider.service.registration.RelyingP
import org.springframework.security.web.SecurityFilterChain;
/**
- * {@link WebSecurityConfigurerAdapter} configuration for Spring Security's relying party
- * SAML support.
+ * {@link WebSecurityConfigurerAdapter} configuration for Spring Security's relying on
+ * party SAML support.
*
* @author Madhura Bhave
*/
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java
index 1958ca4a77..53ab635034 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java
@@ -27,7 +27,7 @@ import org.springframework.core.io.Resource;
import org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding;
/**
- * SAML2 relying party properties.
+ * SAML2 relying on party properties.
*
* @author Madhura Bhave
* @author Phillip Webb
@@ -37,7 +37,7 @@ import org.springframework.security.saml2.provider.service.registration.Saml2Mes
public class Saml2RelyingPartyProperties {
/**
- * SAML2 relying party registrations.
+ * SAML2 relying on party registrations.
*/
private final Map
* The condition can only match the bean definitions that have been processed by the
- * application context so far and, as such, it is strongly recommended using this
+ * application context so far and, as such, it is strongly recommended to use this
* condition on auto-configuration classes only. If a candidate bean may be created by
* another auto-configuration, make sure that the one using this condition runs after.
*
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java
index 6a473743dc..e7acf5deae 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnMissingBean.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -51,7 +51,7 @@ import org.springframework.context.annotation.Conditional;
* already contained in the {@link BeanFactory}.
*
* The condition can only match the bean definitions that have been processed by the
- * application context so far and, as such, it is strongly recommended using this
+ * application context so far and, as such, it is strongly recommended to use this
* condition on auto-configuration classes only. If a candidate bean may be created by
* another auto-configuration, make sure that the one using this condition runs after.
*
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java
index 2d2ce2874c..b077dcee2c 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/ConditionalOnSingleCandidate.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -35,7 +35,7 @@ import org.springframework.context.annotation.Conditional;
* condition match if auto-wiring a bean with the defined type will succeed.
*
* The condition can only match the bean definitions that have been processed by the
- * application context so far and, as such, it is strongly recommended using this
+ * application context so far and, as such, it is strongly recommended to use this
* condition on auto-configuration classes only. If a candidate bean may be created by
* another auto-configuration, make sure that the one using this condition runs after.
*
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java
index b74eea2cd1..8376adcafd 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2LoginConfiguration.java
@@ -26,8 +26,8 @@ import org.springframework.security.saml2.provider.service.registration.RelyingP
import org.springframework.security.web.SecurityFilterChain;
/**
- * {@link WebSecurityConfigurerAdapter} configuration for Spring Security's relying on
- * party SAML support.
+ * {@link WebSecurityConfigurerAdapter} configuration for Spring Security's relying party
+ * SAML support.
*
* @author Madhura Bhave
*/
diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java
index 53ab635034..1958ca4a77 100644
--- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java
+++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/saml2/Saml2RelyingPartyProperties.java
@@ -27,7 +27,7 @@ import org.springframework.core.io.Resource;
import org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding;
/**
- * SAML2 relying on party properties.
+ * SAML2 relying party properties.
*
* @author Madhura Bhave
* @author Phillip Webb
@@ -37,7 +37,7 @@ import org.springframework.security.saml2.provider.service.registration.Saml2Mes
public class Saml2RelyingPartyProperties {
/**
- * SAML2 relying on party registrations.
+ * SAML2 relying party registrations.
*/
private final Map