Polishing (backported from master)

jhoeller · jhoeller · commit dd3262bfe30c · 2021-02-25T19:08:53.000+01:00
diff --git a/spring-aop/src/main/java/org/springframework/aop/DynamicIntroductionAdvice.java b/spring-aop/src/main/java/org/springframework/aop/DynamicIntroductionAdvice.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-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,7 +26,7 @@
  * <p>Introductions are often <b>mixins</b>, enabling the building of composite
  * objects that can achieve many of the goals of multiple inheritance in Java.
  *
- * <p>Compared to {qlink IntroductionInfo}, this interface allows an advice to
+ * <p>Compared to {@link IntroductionInfo}, this interface allows an advice to
  * implement a range of interfaces that is not necessarily known in advance.
  * Thus an {@link IntroductionAdvisor} can be used to specify which interfaces
  * will be exposed in an advised object.
diff --git a/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java b/spring-beans/src/main/java/org/springframework/beans/factory/config/PlaceholderConfigurerSupport.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-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,15 +36,16 @@
  * Example XML bean definition:
  *
  * <pre class="code">
- * &lt;bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/&gt;
- *   &lt;property name="driverClassName" value="${driver}"/&gt;
- *   &lt;property name="url" value="jdbc:${dbname}"/&gt;
+ * &lt;bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"&gt;
+ *   &lt;property name="driverClassName" value="${driver}" /&gt;
+ *   &lt;property name="url" value="jdbc:${dbname}" /&gt;
  * &lt;/bean&gt;
  * </pre>
  *
  * Example properties file:
  *
- * <pre class="code">driver=com.mysql.jdbc.Driver
+ * <pre class="code">
+ * driver=com.mysql.jdbc.Driver
  * dbname=mysql:mydb</pre>
  *
  * Annotated bean definitions may take advantage of property replacement using
@@ -56,7 +57,8 @@
  * in bean references. Furthermore, placeholder values can also cross-reference
  * other placeholders, like:
  *
- * <pre class="code">rootPath=myrootdir
+ * <pre class="code">
+ * rootPath=myrootdir
  * subPath=${rootPath}/subdir</pre>
  *
  * In contrast to {@link PropertyOverrideConfigurer}, subclasses of this type allow
@@ -71,13 +73,13 @@
  *
  * <p>Default property values can be defined globally for each configurer instance
  * via the {@link #setProperties properties} property, or on a property-by-property basis
- * using the default value separator which is {@code ":"} by default and
- * customizable via {@link #setValueSeparator(String)}.
+ * using the value separator which is {@code ":"} by default and customizable via
+ * {@link #setValueSeparator(String)}.
  *
  * <p>Example XML property with default value:
  *
  * <pre class="code">
- *   <property name="url" value="jdbc:${dbname:defaultdb}"/>
+ *   &lt;property name="url" value="jdbc:${dbname:defaultdb}" /&gt;
  * </pre>
  *
  * @author Chris Beams
diff --git a/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java b/spring-context/src/main/java/org/springframework/context/annotation/ConfigurationClassPostProcessor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-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.
@@ -71,12 +71,12 @@
  *
  * <p>Registered by default when using {@code <context:annotation-config/>} or
  * {@code <context:component-scan/>}. Otherwise, may be declared manually as
- * with any other BeanFactoryPostProcessor.
+ * with any other {@link BeanFactoryPostProcessor}.
  *
  * <p>This post processor is priority-ordered as it is important that any
- * {@link Bean} methods declared in {@code @Configuration} classes have
+ * {@link Bean @Bean} methods declared in {@code @Configuration} classes have
  * their corresponding bean definitions registered before any other
- * {@link BeanFactoryPostProcessor} executes.
+ * {@code BeanFactoryPostProcessor} executes.
  *
  * @author Chris Beams
  * @author Juergen Hoeller
diff --git a/spring-context/src/main/java/org/springframework/context/index/CandidateComponentsIndexLoader.java b/spring-context/src/main/java/org/springframework/context/index/CandidateComponentsIndexLoader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-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,13 +48,13 @@ public final class CandidateComponentsIndexLoader {
 	public static final String COMPONENTS_RESOURCE_LOCATION = "META-INF/spring.components";
 
 	/**
-	 * System property that instructs Spring to ignore the index, i.e.
+	 * System property that instructs Spring to ignore the components index, i.e.
 	 * to always return {@code null} from {@link #loadIndex(ClassLoader)}.
 	 * <p>The default is "false", allowing for regular use of the index. Switching this
 	 * flag to {@code true} fulfills a corner case scenario when an index is partially
 	 * available for some libraries (or use cases) but couldn't be built for the whole
 	 * application. In this case, the application context fallbacks to a regular
-	 * classpath arrangement (i.e. as no index was present at all).
+	 * classpath arrangement (i.e. as though no index were present at all).
 	 */
 	public static final String IGNORE_INDEX = "spring.index.ignore";
 
diff --git a/spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java b/spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-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.
@@ -856,8 +856,8 @@ protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory b
 					beanFactory.getBean(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class));
 		}
 
-		// Register a default embedded value resolver if no bean post-processor
-		// (such as a PropertyPlaceholderConfigurer bean) registered any before:
+		// Register a default embedded value resolver if no BeanFactoryPostProcessor
+		// (such as a PropertySourcesPlaceholderConfigurer bean) registered any before:
 		// at this point, primarily for resolution in annotation attribute values.
 		if (!beanFactory.hasEmbeddedValueResolver()) {
 			beanFactory.addEmbeddedValueResolver(strVal -> getEnvironment().resolvePlaceholders(strVal));
diff --git a/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java b/spring-context/src/main/java/org/springframework/format/annotation/DateTimeFormat.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-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,14 +36,17 @@
  *
  * <p>For ISO-based formatting, set the {@link #iso} attribute to be the desired {@link ISO} format,
  * such as {@link ISO#DATE}. For custom formatting, set the {@link #pattern} attribute to be the
- * DateTime pattern, such as {@code yyyy/MM/dd hh:mm:ss a}.
+ * DateTime pattern, such as {@code "yyyy/MM/dd hh:mm:ss a"}.
  *
  * <p>Each attribute is mutually exclusive, so only set one attribute per annotation instance
- * (the one most convenient one for your formatting needs).
- * When the pattern attribute is specified, it takes precedence over both the style and ISO attribute.
- * When the {@link #iso} attribute is specified, it takes precedence over the style attribute.
- * When no annotation attributes are specified, the default format applied is style-based
- * with a style code of 'SS' (short date, short time).
+ * (the one most convenient for your formatting needs).
+ *
+ * <ul>
+ * <li>When the pattern attribute is specified, it takes precedence over both the style and ISO attribute.</li>
+ * <li>When the {@link #iso} attribute is specified, it takes precedence over the style attribute.</li>
+ * <li>When no annotation attributes are specified, the default format applied is style-based
+ * with a style code of 'SS' (short date, short time).</li>
+ * </ul>
  *
  * @author Keith Donald
  * @author Juergen Hoeller
diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationUtils.java b/spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationUtils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-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.
@@ -45,10 +45,10 @@ public abstract class TransactionSynchronizationUtils {
 
 
 	/**
-	 * Check whether the given resource transaction managers refers to the given
+	 * Check whether the given resource transaction manager refers to the given
 	 * (underlying) resource factory.
 	 * @see ResourceTransactionManager#getResourceFactory()
-	 * @see org.springframework.core.InfrastructureProxy#getWrappedObject()
+	 * @see InfrastructureProxy#getWrappedObject()
 	 */
 	public static boolean sameResourceFactory(ResourceTransactionManager tm, Object resourceFactory) {
 		return unwrapResourceIfNecessary(tm.getResourceFactory()).equals(unwrapResourceIfNecessary(resourceFactory));
@@ -57,7 +57,7 @@ public static boolean sameResourceFactory(ResourceTransactionManager tm, Object
 	/**
 	 * Unwrap the given resource handle if necessary; otherwise return
 	 * the given handle as-is.
-	 * @see org.springframework.core.InfrastructureProxy#getWrappedObject()
+	 * @see InfrastructureProxy#getWrappedObject()
 	 */
 	static Object unwrapResourceIfNecessary(Object resource) {
 		Assert.notNull(resource, "Resource must not be null");
@@ -106,8 +106,8 @@ public static void triggerBeforeCompletion() {
 			try {
 				synchronization.beforeCompletion();
 			}
-			catch (Throwable tsex) {
-				logger.error("TransactionSynchronization.beforeCompletion threw exception", tsex);
+			catch (Throwable ex) {
+				logger.error("TransactionSynchronization.beforeCompletion threw exception", ex);
 			}
 		}
 	}
@@ -170,8 +170,8 @@ public static void invokeAfterCompletion(@Nullable List<TransactionSynchronizati
 				try {
 					synchronization.afterCompletion(completionStatus);
 				}
-				catch (Throwable tsex) {
-					logger.error("TransactionSynchronization.afterCompletion threw exception", tsex);
+				catch (Throwable ex) {
+					logger.error("TransactionSynchronization.afterCompletion threw exception", ex);
 				}
 			}
 		}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2018 the original author or authors.`
	`2`	`+ * Copyright 2002-2021 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -36,15 +36,16 @@`
`36`	`36`	`* Example XML bean definition:`
`37`	`37`	`*`
`38`	`38`	`* <pre class="code">`
`39`		`- * <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/>`
`40`		`- * <property name="driverClassName" value="${driver}"/>`
`41`		`- * <property name="url" value="jdbc:${dbname}"/>`
	`39`	`+ * <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">`
	`40`	`+ * <property name="driverClassName" value="${driver}" />`
	`41`	`+ * <property name="url" value="jdbc:${dbname}" />`
`42`	`42`	`* </bean>`
`43`	`43`	`* </pre>`
`44`	`44`	`*`
`45`	`45`	`* Example properties file:`
`46`	`46`	`*`
`47`		`- * <pre class="code">driver=com.mysql.jdbc.Driver`
	`47`	`+ * <pre class="code">`
	`48`	`+ * driver=com.mysql.jdbc.Driver`
`48`	`49`	`* dbname=mysql:mydb</pre>`
`49`	`50`	`*`
`50`	`51`	`* Annotated bean definitions may take advantage of property replacement using`
`@@ -56,7 +57,8 @@`
`56`	`57`	`* in bean references. Furthermore, placeholder values can also cross-reference`
`57`	`58`	`* other placeholders, like:`
`58`	`59`	`*`
`59`		`- * <pre class="code">rootPath=myrootdir`
	`60`	`+ * <pre class="code">`
	`61`	`+ * rootPath=myrootdir`
`60`	`62`	`* subPath=${rootPath}/subdir</pre>`
`61`	`63`	`*`
`62`	`64`	`* In contrast to {@link PropertyOverrideConfigurer}, subclasses of this type allow`
`@@ -71,13 +73,13 @@`
`71`	`73`	`*`
`72`	`74`	`* <p>Default property values can be defined globally for each configurer instance`
`73`	`75`	`* via the {@link #setProperties properties} property, or on a property-by-property basis`
`74`		`- * using the default value separator which is {@code ":"} by default and`
`75`		`- * customizable via {@link #setValueSeparator(String)}.`
	`76`	`+ * using the value separator which is {@code ":"} by default and customizable via`
	`77`	`+ * {@link #setValueSeparator(String)}.`
`76`	`78`	`*`
`77`	`79`	`* <p>Example XML property with default value:`
`78`	`80`	`*`
`79`	`81`	`* <pre class="code">`
`80`		`- * <property name="url" value="jdbc:${dbname:defaultdb}"/>`
	`82`	`+ * <property name="url" value="jdbc:${dbname:defaultdb}" />`
`81`	`83`	`* </pre>`
`82`	`84`	`*`
`83`	`85`	`* @author Chris Beams`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2020 the original author or authors.`
	`2`	`+ * Copyright 2002-2021 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -71,12 +71,12 @@`
`71`	`71`	`*`
`72`	`72`	`* <p>Registered by default when using {@code <context:annotation-config/>} or`
`73`	`73`	`* {@code <context:component-scan/>}. Otherwise, may be declared manually as`
`74`		`- * with any other BeanFactoryPostProcessor.`
	`74`	`+ * with any other {@link BeanFactoryPostProcessor}.`
`75`	`75`	`*`
`76`	`76`	`* <p>This post processor is priority-ordered as it is important that any`
`77`		`- * {@link Bean} methods declared in {@code @Configuration} classes have`
	`77`	`+ * {@link Bean @Bean} methods declared in {@code @Configuration} classes have`
`78`	`78`	`* their corresponding bean definitions registered before any other`
`79`		`- * {@link BeanFactoryPostProcessor} executes.`
	`79`	`+ * {@code BeanFactoryPostProcessor} executes.`
`80`	`80`	`*`
`81`	`81`	`* @author Chris Beams`
`82`	`82`	`* @author Juergen Hoeller`