From 4ccf33e36bc1ca5f9e733638da28d08e75857efa Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Mon, 22 Jan 2018 11:43:21 +0100 Subject: [PATCH] Javadoc format and related polishing (cherry picked from commit 9d0e62e) --- .../cache/annotation/CachingConfigurer.java | 7 +- .../PropertySourcesPlaceholderConfigurer.java | 4 +- .../core/ArgumentPreparedStatementSetter.java | 4 +- .../ArgumentTypePreparedStatementSetter.java | 4 +- .../orm/hibernate5/SessionFactoryUtils.java | 4 +- .../test/annotation/IfProfileValue.java | 6 +- .../test/context/cache/ContextCache.java | 4 +- .../support/AbstractContextLoader.java | 6 +- .../AbstractDelegatingSmartContextLoader.java | 75 ++++++++++--------- .../AnnotationConfigContextLoader.java | 49 +++++------- .../GenericGroovyXmlContextLoader.java | 7 +- .../web/AbstractGenericWebContextLoader.java | 64 ++++++---------- .../web/AnnotationConfigWebContextLoader.java | 48 +++++------- .../web/GenericGroovyXmlWebContextLoader.java | 7 +- .../web/socket/MockServerContainer.java | 6 +- .../test/util/XpathExpectationsHelper.java | 8 +- .../client/match/XpathRequestMatchers.java | 4 +- .../support/AbstractTransactionStatus.java | 9 +-- .../springframework/http/CacheControl.java | 67 ++++++++++------- .../jaxws/LocalJaxWsServiceFactory.java | 1 - ...trixVariableMapMethodArgumentResolver.java | 13 ++-- .../web/servlet/tags/form/LabelTag.java | 4 +- 22 files changed, 190 insertions(+), 211 deletions(-) diff --git a/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java b/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java index 97cfff7acb..1b89ec0e0b 100644 --- a/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.java +++ b/spring-context/src/main/java/org/springframework/cache/annotation/CachingConfigurer.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. @@ -33,6 +33,7 @@ import org.springframework.cache.interceptor.KeyGenerator; * for detailed instructions. * * @author Chris Beams + * @author Stephane Nicoll * @since 3.1 * @see EnableCaching * @see CachingConfigurerSupport @@ -67,8 +68,8 @@ public interface CachingConfigurer { * Return the {@link CacheResolver} bean to use to resolve regular caches for * annotation-driven cache management. This is an alternative and more powerful * option of specifying the {@link CacheManager} to use. - *

If both a {@link #cacheManager()} and {@link #cacheResolver()} are set, the - * cache manager is ignored. + *

If both a {@link #cacheManager()} and {@code #cacheResolver()} are set, + * the cache manager is ignored. *

Implementations must explicitly declare * {@link org.springframework.context.annotation.Bean @Bean}, e.g. *

diff --git a/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java b/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java
index 4a12a31e66..bc72d8de9a 100644
--- a/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.java
+++ b/spring-context/src/main/java/org/springframework/context/support/PropertySourcesPlaceholderConfigurer.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.
@@ -183,7 +183,7 @@ public class PropertySourcesPlaceholderConfigurer extends PlaceholderConfigurerS
 	/**
 	 * Implemented for compatibility with {@link org.springframework.beans.factory.config.PlaceholderConfigurerSupport}.
 	 * @deprecated in favor of {@link #processProperties(ConfigurableListableBeanFactory, ConfigurablePropertyResolver)}
-	 * @throws UnsupportedOperationException
+	 * @throws UnsupportedOperationException in this implementation
 	 */
 	@Override
 	@Deprecated
diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentPreparedStatementSetter.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentPreparedStatementSetter.java
index 75ca1930ef..b52e22996a 100644
--- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentPreparedStatementSetter.java
+++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentPreparedStatementSetter.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.
@@ -55,7 +55,7 @@ public class ArgumentPreparedStatementSetter implements PreparedStatementSetter,
 	 * @param ps the PreparedStatement
 	 * @param parameterPosition index of the parameter position
 	 * @param argValue the value to set
-	 * @throws SQLException
+	 * @throws SQLException if thrown by PreparedStatement methods
 	 */
 	protected void doSetValue(PreparedStatement ps, int parameterPosition, Object argValue) throws SQLException {
 		if (argValue instanceof SqlParameterValue) {
diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentTypePreparedStatementSetter.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentTypePreparedStatementSetter.java
index 9db420e002..8e7b6d7aba 100644
--- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentTypePreparedStatementSetter.java
+++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/ArgumentTypePreparedStatementSetter.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.
@@ -89,7 +89,7 @@ public class ArgumentTypePreparedStatementSetter implements PreparedStatementSet
 	 * @param parameterPosition index of the parameter position
 	 * @param argType the argument type
 	 * @param argValue the argument value
-	 * @throws SQLException
+	 * @throws SQLException if thrown by PreparedStatement methods
 	 */
 	protected void doSetValue(PreparedStatement ps, int parameterPosition, int argType, Object argValue)
 			throws SQLException {
diff --git a/spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java b/spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java
index fafa3f6b78..c6224a6e4e 100644
--- a/spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java
+++ b/spring-orm-hibernate5/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 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.
@@ -130,7 +130,7 @@ public abstract class SessionFactoryUtils {
 	 * {@link PersistenceException} wrappers accordingly.
 	 * @param session the Hibernate Session to flush
 	 * @param synch whether this flush is triggered by transaction synchronization
-	 * @throws DataAccessException
+	 * @throws DataAccessException in case of flush failures
 	 * @since 4.3.2
 	 */
 	static void flush(Session session, boolean synch) throws DataAccessException {
diff --git a/spring-test/src/main/java/org/springframework/test/annotation/IfProfileValue.java b/spring-test/src/main/java/org/springframework/test/annotation/IfProfileValue.java
index 0e8716e088..f286f1c2b0 100644
--- a/spring-test/src/main/java/org/springframework/test/annotation/IfProfileValue.java
+++ b/spring-test/src/main/java/org/springframework/test/annotation/IfProfileValue.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.
@@ -109,7 +109,7 @@ public @interface IfProfileValue {
 	/**
 	 * A single, permissible {@code value} of the profile value
 	 * for the given {@link #name}.
-	 * 

Note: Assigning values to both {@link #value} and {@link #values} + *

Note: Assigning values to both {@code #value} and {@link #values} * will lead to a configuration conflict. */ String value() default ""; @@ -117,7 +117,7 @@ public @interface IfProfileValue { /** * A list of all permissible {@code values} of the profile value * for the given {@link #name}. - *

Note: Assigning values to both {@link #value} and {@link #values} + *

Note: Assigning values to both {@link #value} and {@code #values} * will lead to a configuration conflict. */ String[] values() default {}; diff --git a/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java b/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java index 1f15c76301..9208197f31 100644 --- a/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.java +++ b/spring-test/src/main/java/org/springframework/test/context/cache/ContextCache.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. @@ -53,7 +53,7 @@ public interface ContextCache { String CONTEXT_CACHE_LOGGING_CATEGORY = "org.springframework.test.context.cache"; /** - * The default maximum size of the context cache: {@value #DEFAULT_MAX_CONTEXT_CACHE_SIZE}. + * The default maximum size of the context cache: {@value}. * @since 4.3 * @see #MAX_CONTEXT_CACHE_SIZE_PROPERTY_NAME */ diff --git a/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java index f17782f8a6..4cb44aa8ff 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/AbstractContextLoader.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. @@ -72,7 +72,7 @@ public abstract class AbstractContextLoader implements SmartContextLoader { private static final Log logger = LogFactory.getLog(AbstractContextLoader.class); - // --- SmartContextLoader ----------------------------------------------- + // SmartContextLoader /** * For backwards compatibility with the {@link ContextLoader} SPI, the @@ -189,7 +189,7 @@ public abstract class AbstractContextLoader implements SmartContextLoader { } - // --- ContextLoader ------------------------------------------------------- + // ContextLoader /** * If the supplied {@code locations} are {@code null} or empty diff --git a/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java index c0ae608ed7..95beb5550e 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/AbstractDelegatingSmartContextLoader.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. @@ -66,6 +66,7 @@ import org.springframework.util.Assert; * not result in an exception. * * @author Sam Brannen + * @author Phillip Webb * @since 3.2 * @see SmartContextLoader */ @@ -85,16 +86,13 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte */ protected abstract SmartContextLoader getAnnotationConfigLoader(); - // --- SmartContextLoader -------------------------------------------------- - private static String name(SmartContextLoader loader) { - return loader.getClass().getSimpleName(); - } + // SmartContextLoader private static void delegateProcessing(SmartContextLoader loader, ContextConfigurationAttributes configAttributes) { if (logger.isDebugEnabled()) { - logger.debug(String.format("Delegating to %s to process context configuration %s.", name(loader), - configAttributes)); + logger.debug(String.format("Delegating to %s to process context configuration %s.", + name(loader), configAttributes)); } loader.processContextConfiguration(configAttributes); } @@ -110,10 +108,10 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte private boolean supports(SmartContextLoader loader, MergedContextConfiguration mergedConfig) { if (loader == getAnnotationConfigLoader()) { - return mergedConfig.hasClasses() && !mergedConfig.hasLocations(); + return (mergedConfig.hasClasses() && !mergedConfig.hasLocations()); } else { - return mergedConfig.hasLocations() && !mergedConfig.hasClasses(); + return (mergedConfig.hasLocations() && !mergedConfig.hasClasses()); } } @@ -152,8 +150,8 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte public void processContextConfiguration(final ContextConfigurationAttributes configAttributes) { Assert.notNull(configAttributes, "configAttributes must not be null"); Assert.isTrue(!(configAttributes.hasLocations() && configAttributes.hasClasses()), String.format( - "Cannot process locations AND classes for context configuration %s: " - + "configure one or the other, but not both.", configAttributes)); + "Cannot process locations AND classes for context configuration %s: " + + "configure one or the other, but not both.", configAttributes)); // If the original locations or classes were not empty, there's no // need to bother with default detection checks; just let the @@ -174,14 +172,14 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte if (xmlLoaderDetectedDefaults) { if (logger.isInfoEnabled()) { logger.info(String.format("%s detected default locations for context configuration %s.", - name(getXmlLoader()), configAttributes)); + name(getXmlLoader()), configAttributes)); } } if (configAttributes.hasClasses()) { throw new IllegalStateException(String.format( - "%s should NOT have detected default configuration classes for context configuration %s.", - name(getXmlLoader()), configAttributes)); + "%s should NOT have detected default configuration classes for context configuration %s.", + name(getXmlLoader()), configAttributes)); } // Now let the annotation config loader process the configuration. @@ -190,24 +188,24 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte if (configAttributes.hasClasses()) { if (logger.isInfoEnabled()) { logger.info(String.format( - "%s detected default configuration classes for context configuration %s.", - name(getAnnotationConfigLoader()), configAttributes)); + "%s detected default configuration classes for context configuration %s.", + name(getAnnotationConfigLoader()), configAttributes)); } } if (!xmlLoaderDetectedDefaults && configAttributes.hasLocations()) { throw new IllegalStateException(String.format( - "%s should NOT have detected default locations for context configuration %s.", - name(getAnnotationConfigLoader()), configAttributes)); + "%s should NOT have detected default locations for context configuration %s.", + name(getAnnotationConfigLoader()), configAttributes)); } if (configAttributes.hasLocations() && configAttributes.hasClasses()) { - String message = String.format( - "Configuration error: both default locations AND default configuration classes " - + "were detected for context configuration %s; configure one or the other, but not both.", - configAttributes); - logger.error(message); - throw new IllegalStateException(message); + String msg = String.format( + "Configuration error: both default locations AND default configuration classes " + + "were detected for context configuration %s; configure one or the other, but not both.", + configAttributes); + logger.error(msg); + throw new IllegalStateException(msg); } } } @@ -239,9 +237,9 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte if (mergedConfig.hasLocations() && mergedConfig.hasClasses()) { throw new IllegalStateException(String.format( - "Neither %s nor %s supports loading an ApplicationContext from %s: " - + "declare either 'locations' or 'classes' but not both.", name(getXmlLoader()), - name(getAnnotationConfigLoader()), mergedConfig)); + "Neither %s nor %s supports loading an ApplicationContext from %s: " + + "declare either 'locations' or 'classes' but not both.", name(getXmlLoader()), + name(getAnnotationConfigLoader()), mergedConfig)); } for (SmartContextLoader loader : candidates) { @@ -261,22 +259,28 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte // else... throw new IllegalStateException(String.format( - "Neither %s nor %s was able to load an ApplicationContext from %s.", name(getXmlLoader()), - name(getAnnotationConfigLoader()), mergedConfig)); + "Neither %s nor %s was able to load an ApplicationContext from %s.", name(getXmlLoader()), + name(getAnnotationConfigLoader()), mergedConfig)); } - // --- ContextLoader ------------------------------------------------------- + private static String name(SmartContextLoader loader) { + return loader.getClass().getSimpleName(); + } + + + // ContextLoader /** * {@code AbstractDelegatingSmartContextLoader} does not support the * {@link ContextLoader#processLocations(Class, String...)} method. Call * {@link #processContextConfiguration(ContextConfigurationAttributes)} instead. - * @throws UnsupportedOperationException + * @throws UnsupportedOperationException in this implementation */ @Override public final String[] processLocations(Class clazz, String... locations) { - throw new UnsupportedOperationException("DelegatingSmartContextLoaders do not support the ContextLoader SPI. " - + "Call processContextConfiguration(ContextConfigurationAttributes) instead."); + throw new UnsupportedOperationException( + "DelegatingSmartContextLoaders do not support the ContextLoader SPI. " + + "Call processContextConfiguration(ContextConfigurationAttributes) instead."); } /** @@ -287,8 +291,9 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte */ @Override public final ApplicationContext loadContext(String... locations) throws Exception { - throw new UnsupportedOperationException("DelegatingSmartContextLoaders do not support the ContextLoader SPI. " - + "Call loadContext(MergedContextConfiguration) instead."); + throw new UnsupportedOperationException( + "DelegatingSmartContextLoaders do not support the ContextLoader SPI. " + + "Call loadContext(MergedContextConfiguration) instead."); } } diff --git a/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java index c2b0399a2e..413c97b86b 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.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. @@ -58,11 +58,10 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader private static final Log logger = LogFactory.getLog(AnnotationConfigContextLoader.class); - // --- SmartContextLoader ----------------------------------------------- + // SmartContextLoader /** * Process annotated classes in the supplied {@link ContextConfigurationAttributes}. - * *

If the annotated classes are {@code null} or empty and * {@link #isGenerateDefaultLocations()} returns {@code true}, this * {@code SmartContextLoader} will attempt to {@link @@ -71,7 +70,6 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader * {@link ContextConfigurationAttributes#setClasses(Class[]) set} in the * supplied configuration attributes. Otherwise, properties in the supplied * configuration attributes will not be modified. - * * @param configAttributes the context configuration attributes to process * @see org.springframework.test.context.SmartContextLoader#processContextConfiguration(ContextConfigurationAttributes) * @see #isGenerateDefaultLocations() @@ -84,14 +82,13 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader } } - // --- AnnotationConfigContextLoader --------------------------------------- + + // AnnotationConfigContextLoader /** * Detect the default configuration classes for the supplied test class. - * *

The default implementation simply delegates to * {@link AnnotationConfigContextLoaderUtils#detectDefaultConfigurationClasses(Class)}. - * * @param declaringClass the test class that declared {@code @ContextConfiguration} * @return an array of default configuration classes, potentially empty but * never {@code null} @@ -101,21 +98,21 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader return AnnotationConfigContextLoaderUtils.detectDefaultConfigurationClasses(declaringClass); } - // --- AbstractContextLoader ----------------------------------------------- + + // AbstractContextLoader /** * {@code AnnotationConfigContextLoader} should be used as a * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader}, * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}. * Consequently, this method is not supported. - * + * @throws UnsupportedOperationException in this implementation * @see AbstractContextLoader#modifyLocations - * @throws UnsupportedOperationException */ @Override protected String[] modifyLocations(Class clazz, String... locations) { throw new UnsupportedOperationException( - "AnnotationConfigContextLoader does not support the modifyLocations(Class, String...) method"); + "AnnotationConfigContextLoader does not support the modifyLocations(Class, String...) method"); } /** @@ -123,14 +120,13 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader}, * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}. * Consequently, this method is not supported. - * + * @throws UnsupportedOperationException in this implementation * @see AbstractContextLoader#generateDefaultLocations - * @throws UnsupportedOperationException */ @Override protected String[] generateDefaultLocations(Class clazz) { throw new UnsupportedOperationException( - "AnnotationConfigContextLoader does not support the generateDefaultLocations(Class) method"); + "AnnotationConfigContextLoader does not support the generateDefaultLocations(Class) method"); } /** @@ -138,17 +134,17 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader}, * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}. * Consequently, this method is not supported. - * + * @throws UnsupportedOperationException in this implementation * @see AbstractContextLoader#getResourceSuffix - * @throws UnsupportedOperationException */ @Override protected String getResourceSuffix() { throw new UnsupportedOperationException( - "AnnotationConfigContextLoader does not support the getResourceSuffix() method"); + "AnnotationConfigContextLoader does not support the getResourceSuffix() method"); } - // --- AbstractGenericContextLoader ---------------------------------------- + + // AbstractGenericContextLoader /** * Ensure that the supplied {@link MergedContextConfiguration} does not @@ -159,10 +155,10 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader @Override protected void validateMergedContextConfiguration(MergedContextConfiguration mergedConfig) { if (mergedConfig.hasLocations()) { - String msg = String.format( - "Test class [%s] has been configured with @ContextConfiguration's 'locations' (or 'value') attribute %s, " - + "but %s does not support resource locations.", mergedConfig.getTestClass().getName(), - ObjectUtils.nullSafeToString(mergedConfig.getLocations()), getClass().getSimpleName()); + String msg = String.format("Test class [%s] has been configured with @ContextConfiguration's 'locations' " + + "(or 'value') attribute %s, but %s does not support resource locations.", + mergedConfig.getTestClass().getName(), ObjectUtils.nullSafeToString(mergedConfig.getLocations()), + getClass().getSimpleName()); logger.error(msg); throw new IllegalStateException(msg); } @@ -171,18 +167,14 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader /** * Register classes in the supplied {@link GenericApplicationContext context} * from the classes in the supplied {@link MergedContextConfiguration}. - * *

Each class must represent an annotated class. An * {@link AnnotatedBeanDefinitionReader} is used to register the appropriate * bean definitions. - * *

Note that this method does not call {@link #createBeanDefinitionReader} * since {@code AnnotatedBeanDefinitionReader} is not an instance of * {@link BeanDefinitionReader}. - * * @param context the context in which the annotated classes should be registered * @param mergedConfig the merged configuration from which the classes should be retrieved - * * @see AbstractGenericContextLoader#loadBeanDefinitions */ @Override @@ -199,15 +191,14 @@ public class AnnotationConfigContextLoader extends AbstractGenericContextLoader * {@link org.springframework.test.context.SmartContextLoader SmartContextLoader}, * not as a legacy {@link org.springframework.test.context.ContextLoader ContextLoader}. * Consequently, this method is not supported. - * + * @throws UnsupportedOperationException in this implementation * @see #loadBeanDefinitions * @see AbstractGenericContextLoader#createBeanDefinitionReader - * @throws UnsupportedOperationException */ @Override protected BeanDefinitionReader createBeanDefinitionReader(GenericApplicationContext context) { throw new UnsupportedOperationException( - "AnnotationConfigContextLoader does not support the createBeanDefinitionReader(GenericApplicationContext) method"); + "AnnotationConfigContextLoader does not support the createBeanDefinitionReader(GenericApplicationContext) method"); } } diff --git a/spring-test/src/main/java/org/springframework/test/context/support/GenericGroovyXmlContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/support/GenericGroovyXmlContextLoader.java index 83ee2ba572..a4d68ecf00 100644 --- a/spring-test/src/main/java/org/springframework/test/context/support/GenericGroovyXmlContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/support/GenericGroovyXmlContextLoader.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. @@ -39,7 +39,6 @@ public class GenericGroovyXmlContextLoader extends GenericXmlContextLoader { * Load bean definitions into the supplied {@link GenericApplicationContext context} * from the locations in the supplied {@code MergedContextConfiguration} using a * {@link GroovyBeanDefinitionReader}. - * * @param context the context into which the bean definitions should be loaded * @param mergedConfig the merged context configuration * @see org.springframework.test.context.support.AbstractGenericContextLoader#loadBeanDefinitions @@ -63,12 +62,12 @@ public class GenericGroovyXmlContextLoader extends GenericXmlContextLoader { * resource types for detection of defaults. Consequently, this method * is not supported. * @see #getResourceSuffixes() - * @throws UnsupportedOperationException + * @throws UnsupportedOperationException in this implementation */ @Override protected String getResourceSuffix() { throw new UnsupportedOperationException( - "GenericGroovyXmlContextLoader does not support the getResourceSuffix() method"); + "GenericGroovyXmlContextLoader does not support the getResourceSuffix() method"); } } diff --git a/spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.java index a74ca6a2ca..f0c36dee7a 100644 --- a/spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.java +++ b/spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.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. @@ -63,14 +63,12 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa protected static final Log logger = LogFactory.getLog(AbstractGenericWebContextLoader.class); - // --- SmartContextLoader ----------------------------------------------- + // SmartContextLoader /** * Load a Spring {@link WebApplicationContext} from the supplied * {@link MergedContextConfiguration}. - * *

Implementation details: - * *

- * * @return a new web application context * @see org.springframework.test.context.SmartContextLoader#loadContext(MergedContextConfiguration) * @see GenericWebApplicationContext */ @Override public final ConfigurableApplicationContext loadContext(MergedContextConfiguration mergedConfig) throws Exception { - if (!(mergedConfig instanceof WebMergedContextConfiguration)) { throw new IllegalArgumentException(String.format( - "Cannot load WebApplicationContext from non-web merged context configuration %s. " - + "Consider annotating your test class with @WebAppConfiguration.", mergedConfig)); + "Cannot load WebApplicationContext from non-web merged context configuration %s. " + + "Consider annotating your test class with @WebAppConfiguration.", mergedConfig)); } WebMergedContextConfiguration webMergedConfig = (WebMergedContextConfiguration) mergedConfig; @@ -152,20 +148,15 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa /** * Configures web resources for the supplied web application context (WAC). - * *

Implementation Details

- * *

If the supplied WAC has no parent or its parent is not a WAC, the * supplied WAC will be configured as the Root WAC (see "Root WAC * Configuration" below). - * *

Otherwise the context hierarchy of the supplied WAC will be traversed * to find the top-most WAC (i.e., the root); and the {@link ServletContext} * of the Root WAC will be set as the {@code ServletContext} for the supplied * WAC. - * *

Root WAC Configuration

- * *