Polishing

Author: jhoeller

spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurationSelector.java

@@ -26,9 +26,9 @@
 import org.springframework.util.StringUtils;
 
 /**
- * Selects which implementation of {@link AbstractCachingConfiguration} should be used
- * based on the value of {@link EnableCaching#mode} on the importing {@code @Configuration}
- * class.
+ * Selects which implementation of {@link AbstractCachingConfiguration} should
+ * be used based on the value of {@link EnableCaching#mode} on the importing
+ * {@code @Configuration} class.
  *
  * <p>Detects the presence of JSR-107 and enables JCache support accordingly.
  *
@@ -58,9 +58,9 @@ public class CachingConfigurationSelector extends AdviceModeImportSelector<Enabl
 
 
 	/**
-	 * {@inheritDoc}
-	 * @return {@link ProxyCachingConfiguration} or {@code AspectJCacheConfiguration} for
-	 * {@code PROXY} and {@code ASPECTJ} values of {@link EnableCaching#mode()}, respectively
+	 * Returns {@link ProxyCachingConfiguration} or {@code AspectJCachingConfiguration}
+	 * for {@code PROXY} and {@code ASPECTJ} values of {@link EnableCaching#mode()},
+	 * respectively. Potentially includes corresponding JCache configuration as well.
 	 */
 	@Override
 	public String[] selectImports(AdviceMode adviceMode) {
@@ -79,7 +79,7 @@ public String[] selectImports(AdviceMode adviceMode) {
 	 * <p>Take care of adding the necessary JSR-107 import if it is available.
 	 */
 	private String[] getProxyImports() {
-		List<String> result = new ArrayList<String>();
+		List<String> result = new ArrayList<String>(3);
 		result.add(AutoProxyRegistrar.class.getName());
 		result.add(ProxyCachingConfiguration.class.getName());
 		if (jsr107Present && jcacheImplPresent) {
@@ -93,7 +93,7 @@ private String[] getProxyImports() {
 	 * <p>Take care of adding the necessary JSR-107 import if it is available.
 	 */
 	private String[] getAspectJImports() {
-		List<String> result = new ArrayList<String>();
+		List<String> result = new ArrayList<String>(2);
 		result.add(CACHE_ASPECT_CONFIGURATION_CLASS_NAME);
 		if (jsr107Present && jcacheImplPresent) {
 			result.add(JCACHE_ASPECT_CONFIGURATION_CLASS_NAME);

spring-context/src/main/java/org/springframework/context/annotation/AdviceMode.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -17,8 +17,8 @@
 package org.springframework.context.annotation;
 
 /**
- * Enumeration used to determine whether JDK proxy-based or AspectJ weaving-based advice
- * should be applied.
+ * Enumeration used to determine whether JDK proxy-based or
+ * AspectJ weaving-based advice should be applied.
  *
  * @author Chris Beams
  * @since 3.1
@@ -27,6 +27,15 @@
  * @see org.springframework.transaction.annotation.EnableTransactionManagement#mode()
  */
 public enum AdviceMode {
+
+	/**
+	 * JDK proxy-based advice.
+	 */
 	PROXY,
+
+	/**
+	 * AspectJ weaving-based advice.
+	 */
 	ASPECTJ
+
 }

spring-context/src/main/java/org/springframework/context/annotation/AdviceModeImportSelector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 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 @@
 import org.springframework.core.annotation.AnnotationAttributes;
 import org.springframework.core.type.AnnotationMetadata;
 
- /**
+/**
  * Convenient base class for {@link ImportSelector} implementations that select imports
  * based on an {@link AdviceMode} value from an annotation (such as the {@code @Enable*}
  * annotations).
@@ -33,6 +33,9 @@
  */
 public abstract class AdviceModeImportSelector<A extends Annotation> implements ImportSelector {
 
+	/**
+	 * The default advice mode attribute name.
+	 */
 	public static final String DEFAULT_ADVICE_MODE_ATTRIBUTE_NAME = "mode";
 
 
@@ -59,31 +62,31 @@ protected String getAdviceModeAttributeName() {
 	 */
 	@Override
 	public final String[] selectImports(AnnotationMetadata importingClassMetadata) {
-		Class<?> annoType = GenericTypeResolver.resolveTypeArgument(getClass(), AdviceModeImportSelector.class);
-		AnnotationAttributes attributes = AnnotationConfigUtils.attributesFor(importingClassMetadata, annoType);
+		Class<?> annType = GenericTypeResolver.resolveTypeArgument(getClass(), AdviceModeImportSelector.class);
+		AnnotationAttributes attributes = AnnotationConfigUtils.attributesFor(importingClassMetadata, annType);
 		if (attributes == null) {
 			throw new IllegalArgumentException(String.format(
-				"@%s is not present on importing class '%s' as expected",
-				annoType.getSimpleName(), importingClassMetadata.getClassName()));
+					"@%s is not present on importing class '%s' as expected",
+					annType.getSimpleName(), importingClassMetadata.getClassName()));
 		}
 
-		AdviceMode adviceMode = attributes.getEnum(this.getAdviceModeAttributeName());
+		AdviceMode adviceMode = attributes.getEnum(getAdviceModeAttributeName());
 		String[] imports = selectImports(adviceMode);
 		if (imports == null) {
-			throw new IllegalArgumentException(String.format("Unknown AdviceMode: '%s'", adviceMode));
+			throw new IllegalArgumentException("Unknown AdviceMode: " + adviceMode);
 		}
 		return imports;
 	}
 
 	/**
 	 * Determine which classes should be imported based on the given {@code AdviceMode}.
-	 * <p>Returning {@code null} from this method indicates that the {@code AdviceMode} could
-	 * not be handled or was unknown and that an {@code IllegalArgumentException} should
-	 * be thrown.
+	 * <p>Returning {@code null} from this method indicates that the {@code AdviceMode}
+	 * could not be handled or was unknown and that an {@code IllegalArgumentException}
+	 * should be thrown.
 	 * @param adviceMode the value of the {@linkplain #getAdviceModeAttributeName()
 	 * advice mode attribute} for the annotation specified via generics.
-	 * @return array containing classes to import; empty array if none, {@code null} if
-	 * the given {@code AdviceMode} is unknown.
+	 * @return array containing classes to import (empty array if none;
+	 * {@code null} if the given {@code AdviceMode} is unknown)
 	 */
 	protected abstract String[] selectImports(AdviceMode adviceMode);
 

spring-context/src/main/java/org/springframework/context/annotation/AnnotationConfigApplicationContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -37,8 +37,8 @@
  *
  * <p>See @{@link Configuration}'s javadoc for usage examples.
  *
- * @author Chris Beams
  * @author Juergen Hoeller
+ * @author Chris Beams
  * @since 3.0
  * @see #register
  * @see #scan
@@ -97,9 +97,8 @@ public AnnotationConfigApplicationContext(String... basePackages) {
 
 
 	/**
-	 * {@inheritDoc}
-	 * <p>Delegates given environment to underlying {@link AnnotatedBeanDefinitionReader}
-	 * and {@link ClassPathBeanDefinitionScanner} members.
+	 * Propagates the given custom {@code Environment} to the underlying
+	 * {@link AnnotatedBeanDefinitionReader} and {@link ClassPathBeanDefinitionScanner}.
 	 */
 	@Override
 	public void setEnvironment(ConfigurableEnvironment environment) {

spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java

@@ -40,21 +40,22 @@
  * Spring {@link Environment} and its set of {@link PropertySources}.
  *
  * <p>This class is designed as a general replacement for {@code PropertyPlaceholderConfigurer}
- * in Spring 3.1 applications. It is used by default to support the {@code property-placeholder}
- * element in working against the spring-context-3.1 XSD, whereas spring-context versions
- * &lt;= 3.0 default to {@code PropertyPlaceholderConfigurer} to ensure backward compatibility.
- * See the spring-context XSD documentation for complete details.
+ * introduced in Spring 3.1. It is used by default to support the {@code property-placeholder}
+ * element in working against the spring-context-3.1 or higher XSD, whereas spring-context
+ * versions &lt;= 3.0 default to {@code PropertyPlaceholderConfigurer} to ensure backward
+ * compatibility. See the spring-context XSD documentation for complete details.
  *
  * <p>Any local properties (e.g. those added via {@link #setProperties}, {@link #setLocations}
  * et al.) are added as a {@code PropertySource}. Search precedence of local properties is
  * based on the value of the {@link #setLocalOverride localOverride} property, which is by
  * default {@code false} meaning that local properties are to be searched last, after all
  * environment property sources.
  *
- * <p>See {@link org.springframework.core.env.ConfigurableEnvironment ConfigurableEnvironment}
- * and related javadocs for details on manipulating environment property sources.
+ * <p>See {@link org.springframework.core.env.ConfigurableEnvironment} and related javadocs
+ * for details on manipulating environment property sources.
  *
  * @author Chris Beams
+ * @author Juergen Hoeller
  * @since 3.1
  * @see org.springframework.core.env.ConfigurableEnvironment
  * @see org.springframework.beans.factory.config.PlaceholderConfigurerSupport
@@ -84,17 +85,17 @@ public class PropertySourcesPlaceholderConfigurer extends PlaceholderConfigurerS
 
 	/**
 	 * Customize the set of {@link PropertySources} to be used by this configurer.
-	 * Setting this property indicates that environment property sources and local
-	 * properties should be ignored.
+	 * <p>Setting this property indicates that environment property sources and
+	 * local properties should be ignored.
 	 * @see #postProcessBeanFactory
 	 */
 	public void setPropertySources(PropertySources propertySources) {
 		this.propertySources = new MutablePropertySources(propertySources);
 	}
 
 	/**
-	 * {@inheritDoc}
-	 * <p>{@code PropertySources} from this environment will be searched when replacing ${...} placeholders.
+	 * {@code PropertySources} from the given {@link Environment}
+	 * will be searched when replacing ${...} placeholders.
 	 * @see #setPropertySources
 	 * @see #postProcessBeanFactory
 	 */
@@ -105,8 +106,7 @@ public void setEnvironment(Environment environment) {
 
 
 	/**
-	 * {@inheritDoc}
-	 * <p>Processing occurs by replacing ${...} placeholders in bean definitions by resolving each
+	 * Processing occurs by replacing ${...} placeholders in bean definitions by resolving each
 	 * against this configurer's set of {@link PropertySources}, which includes:
 	 * <ul>
 	 * <li>all {@linkplain org.springframework.core.env.ConfigurableEnvironment#getPropertySources
@@ -181,8 +181,10 @@ public String resolveStringValue(String strVal) {
 	}
 
 	/**
-	 * Implemented for compatibility with {@link org.springframework.beans.factory.config.PlaceholderConfigurerSupport}.
-	 * @deprecated in favor of {@link #processProperties(ConfigurableListableBeanFactory, ConfigurablePropertyResolver)}
+	 * Implemented for compatibility with
+	 * {@link org.springframework.beans.factory.config.PlaceholderConfigurerSupport}.
+	 * @deprecated in favor of
+	 * {@link #processProperties(ConfigurableListableBeanFactory, ConfigurablePropertyResolver)}
 	 * @throws UnsupportedOperationException in this implementation
 	 */
 	@Override
@@ -193,14 +195,14 @@ protected void processProperties(ConfigurableListableBeanFactory beanFactory, Pr
 	}
 
 	/**
-	 * Returns the property sources that were actually applied during
+	 * Return the property sources that were actually applied during
 	 * {@link #postProcessBeanFactory(ConfigurableListableBeanFactory) post-processing}.
 	 * @return the property sources that were applied
 	 * @throws IllegalStateException if the property sources have not yet been applied
 	 * @since 4.0
 	 */
 	public PropertySources getAppliedPropertySources() throws IllegalStateException {
-		Assert.state(this.appliedPropertySources != null, "PropertySources have not get been applied");
+		Assert.state(this.appliedPropertySources != null, "PropertySources have not yet been applied");
 		return this.appliedPropertySources;
 	}
 

spring-context/src/main/java/org/springframework/scheduling/annotation/AsyncConfigurationSelector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -20,10 +20,12 @@
 import org.springframework.context.annotation.AdviceModeImportSelector;
 
 /**
- * Selects which implementation of {@link AbstractAsyncConfiguration} should be used based
- * on the value of {@link EnableAsync#mode} on the importing {@code @Configuration} class.
+ * Selects which implementation of {@link AbstractAsyncConfiguration} should
+ * be used based on the value of {@link EnableAsync#mode} on the importing
+ * {@code @Configuration} class.
  *
  * @author Chris Beams
+ * @author Juergen Hoeller
  * @since 3.1
  * @see EnableAsync
  * @see ProxyAsyncConfiguration
@@ -33,18 +35,19 @@ public class AsyncConfigurationSelector extends AdviceModeImportSelector<EnableA
 	private static final String ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME =
 			"org.springframework.scheduling.aspectj.AspectJAsyncConfiguration";
 
+
 	/**
-	 * {@inheritDoc}
-	 * @return {@link ProxyAsyncConfiguration} or {@code AspectJAsyncConfiguration} for
-	 * {@code PROXY} and {@code ASPECTJ} values of {@link EnableAsync#mode()}, respectively
+	 * Returns {@link ProxyAsyncConfiguration} or {@code AspectJAsyncConfiguration}
+	 * for {@code PROXY} and {@code ASPECTJ} values of {@link EnableAsync#mode()},
+	 * respectively.
 	 */
 	@Override
 	public String[] selectImports(AdviceMode adviceMode) {
 		switch (adviceMode) {
 			case PROXY:
-				return new String[] { ProxyAsyncConfiguration.class.getName() };
+				return new String[] {ProxyAsyncConfiguration.class.getName()};
 			case ASPECTJ:
-				return new String[] { ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME };
+				return new String[] {ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME};
 			default:
 				return null;
 		}

spring-tx/src/main/java/org/springframework/transaction/annotation/TransactionManagementConfigurationSelector.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2018 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,18 +35,20 @@
 public class TransactionManagementConfigurationSelector extends AdviceModeImportSelector<EnableTransactionManagement> {
 
 	/**
-	 * {@inheritDoc}
-	 * @return {@link ProxyTransactionManagementConfiguration} or
-	 * {@code AspectJTransactionManagementConfiguration} for {@code PROXY} and
-	 * {@code ASPECTJ} values of {@link EnableTransactionManagement#mode()}, respectively
+	 * Returns {@link ProxyTransactionManagementConfiguration} or
+	 * {@code AspectJTransactionManagementConfiguration} for {@code PROXY}
+	 * and {@code ASPECTJ} values of {@link EnableTransactionManagement#mode()},
+	 * respectively.
 	 */
 	@Override
 	protected String[] selectImports(AdviceMode adviceMode) {
 		switch (adviceMode) {
 			case PROXY:
-				return new String[] {AutoProxyRegistrar.class.getName(), ProxyTransactionManagementConfiguration.class.getName()};
+				return new String[] {AutoProxyRegistrar.class.getName(),
+						ProxyTransactionManagementConfiguration.class.getName()};
 			case ASPECTJ:
-				return new String[] {TransactionManagementConfigUtils.TRANSACTION_ASPECT_CONFIGURATION_CLASS_NAME};
+				return new String[] {
+						TransactionManagementConfigUtils.TRANSACTION_ASPECT_CONFIGURATION_CLASS_NAME};
 			default:
 				return null;
 		}