Polishing

Author: jhoeller

Diff for: spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractAutowireCapableBeanFactory.java

@@ -97,10 +97,10 @@
  * Supports autowiring constructors, properties by name, and properties by type.
  *
  * <p>The main template method to be implemented by subclasses is
- * {@link #resolveDependency(DependencyDescriptor, String, Set, TypeConverter)},
- * used for autowiring by type. In case of a factory which is capable of searching
- * its bean definitions, matching beans will typically be implemented through such
- * a search. For other factory styles, simplified matching algorithms can be implemented.
+ * {@link #resolveDependency(DependencyDescriptor, String, Set, TypeConverter)}, used for
+ * autowiring. In case of a {@link org.springframework.beans.factory.ListableBeanFactory}
+ * which is capable of searching its bean definitions, matching beans will typically be
+ * implemented through such a search. Otherwise, simplified matching can be implemented.
  *
  * <p>Note that this class does <i>not</i> assume or implement bean definition
  * registry capabilities. See {@link DefaultListableBeanFactory} for an implementation
@@ -675,7 +675,7 @@ protected Class<?> predictBeanType(String beanName, RootBeanDefinition mbd, Clas
 		// Apply SmartInstantiationAwareBeanPostProcessors to predict the
 		// eventual type after a before-instantiation shortcut.
 		if (targetType != null && !mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) {
-			boolean matchingOnlyFactoryBean = typesToMatch.length == 1 && typesToMatch[0] == FactoryBean.class;
+			boolean matchingOnlyFactoryBean = (typesToMatch.length == 1 && typesToMatch[0] == FactoryBean.class);
 			for (SmartInstantiationAwareBeanPostProcessor bp : getBeanPostProcessorCache().smartInstantiationAware) {
 				Class<?> predicted = bp.predictBeanType(targetType, beanName);
 				if (predicted != null &&

Diff for: spring-beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -749,7 +749,7 @@ public String[] getAliases(String name) {
 			aliases.add(fullBeanName);
 		}
 		String[] retrievedAliases = super.getAliases(beanName);
-		String prefix = factoryPrefix ? FACTORY_BEAN_PREFIX : "";
+		String prefix = (factoryPrefix ? FACTORY_BEAN_PREFIX : "");
 		for (String retrievedAlias : retrievedAliases) {
 			String alias = prefix + retrievedAlias;
 			if (!alias.equals(name)) {

Diff for: spring-beans/src/main/java/org/springframework/beans/factory/support/ConstructorResolver.java

@@ -107,11 +107,7 @@ public ConstructorResolver(AbstractAutowireCapableBeanFactory beanFactory) {
 
 	/**
 	 * "autowire constructor" (with constructor arguments by type) behavior.
-	 * Also applied if explicit constructor argument values are specified,
-	 * matching all remaining arguments with beans from the bean factory.
-	 * <p>This corresponds to constructor injection: In this mode, a Spring
-	 * bean factory is able to host components that expect constructor-based
-	 * dependency resolution.
+	 * Also applied if explicit constructor argument values are specified.
 	 * @param beanName the name of the bean
 	 * @param mbd the merged bean definition for the bean
 	 * @param chosenCtors chosen candidate constructors (or {@code null} if none)

Diff for: spring-context-support/src/main/java/org/springframework/cache/caffeine/CaffeineCacheManager.java

@@ -236,7 +236,7 @@ protected Cache adaptCaffeineCache(String name, com.github.benmanes.caffeine.cac
 	 * Build a common {@link CaffeineCache} instance for the specified cache name,
 	 * using the common Caffeine configuration specified on this cache manager.
 	 * <p>Delegates to {@link #adaptCaffeineCache} as the adaptation method to
-	 * Spring's cache abstraction (allowing for centralized decoration etc),
+	 * Spring's cache abstraction (allowing for centralized decoration etc.),
 	 * passing in a freshly built native Caffeine Cache instance.
 	 * @param name the name of the cache
 	 * @return the Spring CaffeineCache adapter (or a decorator thereof)

Diff for: spring-context/src/main/java/org/springframework/cache/interceptor/CacheAspectSupport.java

@@ -547,10 +547,10 @@ private Cache.ValueWrapper findCachedItem(Collection<CacheOperationContext> cont
 	}
 
 	/**
-	 * Collect the {@link CachePutRequest} for all {@link CacheOperation} using
-	 * the specified result value.
+	 * Collect a {@link CachePutRequest} for every {@link CacheOperation}
+	 * using the specified result value.
 	 * @param contexts the contexts to handle
-	 * @param result the result value (never {@code null})
+	 * @param result the result value
 	 * @param putRequests the collection to update
 	 */
 	private void collectPutRequests(Collection<CacheOperationContext> contexts,

Diff for: spring-context/src/main/java/org/springframework/cache/interceptor/CacheOperationInvoker.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -22,7 +22,7 @@
  * Abstract the invocation of a cache operation.
  *
  * <p>Does not provide a way to transmit checked exceptions but
- * provide a special exception that should be used to wrap any
+ * provides a special exception that should be used to wrap any
  * exception that was thrown by the underlying invocation.
  * Callers are expected to handle this issue type specifically.
  *

Diff for: spring-context/src/main/java/org/springframework/context/annotation/ClassPathScanningCandidateComponentProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -62,11 +62,13 @@
 import org.springframework.util.ClassUtils;
 
 /**
- * A component provider that provides candidate components from a base package. Can
- * use {@link CandidateComponentsIndex the index} if it is available of scans the
- * classpath otherwise. Candidate components are identified by applying exclude and
- * include filters. {@link AnnotationTypeFilter}, {@link AssignableTypeFilter} include
- * filters on an annotation/superclass that are annotated with {@link Indexed} are
+ * A component provider that scans for candidate components starting from a
+ * specified base package. Can use the {@linkplain CandidateComponentsIndex component
+ * index}, if it is available, and scans the classpath otherwise.
+ *
+ * <p>Candidate components are identified by applying exclude and include filters.
+ * {@link AnnotationTypeFilter} and {@link AssignableTypeFilter} include filters
+ * for an annotation/target-type that is annotated with {@link Indexed} are
  * supported: if any other include filter is specified, the index is ignored and
  * classpath scanning is used instead.
  *
@@ -304,7 +306,7 @@ public final MetadataReaderFactory getMetadataReaderFactory() {
 
 
 	/**
-	 * Scan the class path for candidate components.
+	 * Scan the component index or class path for candidate components.
 	 * @param basePackage the package to check for annotated classes
 	 * @return a corresponding Set of autodetected bean definitions
 	 */
@@ -318,7 +320,7 @@ public Set<BeanDefinition> findCandidateComponents(String basePackage) {
 	}
 
 	/**
-	 * Determine if the index can be used by this instance.
+	 * Determine if the component index can be used by this instance.
 	 * @return {@code true} if the index is available and the configuration of this
 	 * instance is supported by it, {@code false} otherwise
 	 * @since 5.0
@@ -454,8 +456,7 @@ private Set<BeanDefinition> scanCandidateComponents(String basePackage) {
 					}
 				}
 				catch (Throwable ex) {
-					throw new BeanDefinitionStoreException(
-							"Failed to read candidate component class: " + resource, ex);
+					throw new BeanDefinitionStoreException("Failed to read candidate component class: " + resource, ex);
 				}
 			}
 		}

Diff for: spring-context/src/main/java/org/springframework/context/support/AbstractApplicationContext.java

@@ -211,7 +211,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader
 	/** Flag that indicates whether this context has been closed already. */
 	private final AtomicBoolean closed = new AtomicBoolean();
 
-	/** Synchronization monitor for the "refresh" and "destroy". */
+	/** Synchronization monitor for "refresh" and "close". */
 	private final Object startupShutdownMonitor = new Object();
 
 	/** Reference to the JVM shutdown hook, if registered. */

Diff for: spring-context/src/main/java/org/springframework/scheduling/TaskScheduler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2020 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -29,7 +29,7 @@
  * {@link Runnable Runnables} based on different kinds of triggers.
  *
  * <p>This interface is separate from {@link SchedulingTaskExecutor} since it
- * usually represents for a different kind of backend, i.e. a thread pool with
+ * usually represents a different kind of backend, i.e. a thread pool with
  * different characteristics and capabilities. Implementations may implement
  * both interfaces if they can handle both kinds of execution characteristics.
  *

Diff for: spring-context/src/test/java/org/springframework/context/annotation/PropertySourceAnnotationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -138,8 +138,8 @@ void withCustomFactoryAsMeta() {
 	@Test
 	void withUnresolvablePlaceholder() {
 		assertThatExceptionOfType(BeanDefinitionStoreException.class)
-			.isThrownBy(() -> new AnnotationConfigApplicationContext(ConfigWithUnresolvablePlaceholder.class))
-			.withCauseInstanceOf(IllegalArgumentException.class);
+				.isThrownBy(() -> new AnnotationConfigApplicationContext(ConfigWithUnresolvablePlaceholder.class))
+				.withCauseInstanceOf(IllegalArgumentException.class);
 	}
 
 	@Test
@@ -170,8 +170,8 @@ void withResolvablePlaceholderAndFactoryBean() {
 	@Test
 	void withEmptyResourceLocations() {
 		assertThatExceptionOfType(BeanDefinitionStoreException.class)
-			.isThrownBy(() -> new AnnotationConfigApplicationContext(ConfigWithEmptyResourceLocations.class))
-			.withCauseInstanceOf(IllegalArgumentException.class);
+				.isThrownBy(() -> new AnnotationConfigApplicationContext(ConfigWithEmptyResourceLocations.class))
+				.withCauseInstanceOf(IllegalArgumentException.class);
 	}
 
 	@Test
@@ -253,8 +253,8 @@ void withNamedPropertySources() {
 	@Test
 	void withMissingPropertySource() {
 		assertThatExceptionOfType(BeanDefinitionStoreException.class)
-			.isThrownBy(() -> new AnnotationConfigApplicationContext(ConfigWithMissingPropertySource.class))
-			.withCauseInstanceOf(FileNotFoundException.class);
+				.isThrownBy(() -> new AnnotationConfigApplicationContext(ConfigWithMissingPropertySource.class))
+				.withCauseInstanceOf(FileNotFoundException.class);
 	}
 
 	@Test

Diff for: spring-context/src/test/java/org/springframework/context/support/GenericApplicationContextTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 the original author or authors.
+ * Copyright 2002-2023 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.
@@ -102,16 +102,16 @@ void accessAfterClosing() {
 
 		assertThat(context.getBean(String.class)).isSameAs(context.getBean("testBean"));
 		assertThat(context.getAutowireCapableBeanFactory().getBean(String.class))
-			.isSameAs(context.getAutowireCapableBeanFactory().getBean("testBean"));
+				.isSameAs(context.getAutowireCapableBeanFactory().getBean("testBean"));
 
 		context.close();
 
 		assertThatIllegalStateException()
-			.isThrownBy(() -> context.getBean(String.class));
+				.isThrownBy(() -> context.getBean(String.class));
 		assertThatIllegalStateException()
-			.isThrownBy(() -> context.getAutowireCapableBeanFactory().getBean(String.class));
+				.isThrownBy(() -> context.getAutowireCapableBeanFactory().getBean(String.class));
 		assertThatIllegalStateException()
-			.isThrownBy(() -> context.getAutowireCapableBeanFactory().getBean("testBean"));
+				.isThrownBy(() -> context.getAutowireCapableBeanFactory().getBean("testBean"));
 	}
 
 	@Test

Diff for: spring-context/src/test/resources/org/springframework/beans/factory/xml/XmlBeanFactoryTests-delegationOverrides.xml

@@ -3,9 +3,6 @@
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
 
-	<!--
-		Not yet in use: illustration of possible approach
-	-->
 	<bean id="overrideOneMethod" class="org.springframework.beans.factory.xml.OverrideOneMethod">
 
 		<lookup-method name="getPrototypeDependency" bean="jenny"/>
@@ -27,39 +24,34 @@
 
 		<lookup-method name="protectedOverrideSingleton" bean="david"/>
 
-		<!--
-			This method is not overloaded, so we don't need to specify any arg types
-		-->
+		<!-- This method is not overloaded, so we don't need to specify any arg types -->
 		<replaced-method name="doSomething" replacer="doSomethingReplacer"/>
 
 	</bean>
 
-	<bean id="replaceVoidMethod" parent="someParent"
-			class="org.springframework.beans.factory.xml.OverrideOneMethodSubclass">
+	<bean id="replaceVoidMethod" parent="someParent" class="org.springframework.beans.factory.xml.OverrideOneMethodSubclass"/>
 
+	<bean id="replaceEchoMethod" class="org.springframework.beans.factory.xml.EchoService">
+		<!-- This method is not overloaded, so we don't need to specify any arg types -->
+		<replaced-method name="echo" replacer="reverseArrayReplacer" />
 	</bean>
 
-	<bean id="reverseReplacer"
-		class="org.springframework.beans.factory.xml.ReverseMethodReplacer"/>
+	<bean id="reverseReplacer" class="org.springframework.beans.factory.xml.ReverseMethodReplacer"/>
 
-	<bean id="fixedReplacer"
-		class="org.springframework.beans.factory.xml.FixedMethodReplacer"/>
+	<bean id="reverseArrayReplacer" class="org.springframework.beans.factory.xml.ReverseArrayMethodReplacer"/>
 
-	<bean id="doSomethingReplacer"
-		class="org.springframework.beans.factory.xml.XmlBeanFactoryTests$DoSomethingReplacer"/>
+	<bean id="fixedReplacer" class="org.springframework.beans.factory.xml.FixedMethodReplacer"/>
 
-	<bean id="serializableReplacer"
-		class="org.springframework.beans.factory.xml.SerializableMethodReplacerCandidate">
+	<bean id="doSomethingReplacer" class="org.springframework.beans.factory.xml.XmlBeanFactoryTests$DoSomethingReplacer"/>
 
+	<bean id="serializableReplacer" class="org.springframework.beans.factory.xml.SerializableMethodReplacerCandidate">
 		<!-- Arbitrary method replacer -->
 		<replaced-method name="replaceMe" replacer="reverseReplacer">
 			<arg-type>String</arg-type>
 		</replaced-method>
-
 	</bean>
 
-	<bean id="jenny" class="org.springframework.beans.testfixture.beans.TestBean"
-		scope="prototype">
+	<bean id="jenny" class="org.springframework.beans.testfixture.beans.TestBean" scope="prototype">
 		<property name="name"><value>Jenny</value></property>
 		<property name="age"><value>30</value></property>
 		<property name="spouse">
@@ -68,8 +60,7 @@
 		</property>
 	</bean>
 
-	<bean id="david" class="org.springframework.beans.testfixture.beans.TestBean"
-		scope="singleton">
+	<bean id="david" class="org.springframework.beans.testfixture.beans.TestBean" scope="singleton">
 		<description>
 			Simple bean, without any collections.
 		</description>

Diff for: spring-core/src/main/java/org/springframework/core/SerializableTypeWrapper.java

@@ -159,7 +159,7 @@ interface TypeProvider extends Serializable {
 
 		/**
 		 * Return the source of the type, or {@code null} if not known.
-		 * <p>The default implementations returns {@code null}.
+		 * <p>The default implementation returns {@code null}.
 		 */
 		@Nullable
 		default Object getSource() {