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 348281fbe1b..673c1496708 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. @@ -34,6 +34,7 @@ import org.springframework.lang.Nullable; * for detailed instructions. * * @author Chris Beams + * @author Stephane Nicoll * @since 3.1 * @see EnableCaching * @see CachingConfigurerSupport @@ -69,8 +70,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 032a0ed5eeb..0a299aff3cb 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-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.
@@ -185,7 +185,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 7399eb3371b..c73fa2bc9ad 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-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.
@@ -58,7 +58,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 25fa5e3f46b..a4a726a4c26 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-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.
@@ -92,7 +92,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-jdbc/src/main/java/org/springframework/jdbc/core/namedparam/SqlParameterSourceUtils.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/namedparam/SqlParameterSourceUtils.java
index af7c6dca940..0ff5d6f0470 100644
--- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/namedparam/SqlParameterSourceUtils.java
+++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/namedparam/SqlParameterSourceUtils.java
@@ -42,7 +42,7 @@ public abstract class SqlParameterSourceUtils {
* @return an array of {@link SqlParameterSource}
* @see MapSqlParameterSource
* @see BeanPropertySqlParameterSource
- * @see NamedParameterJdbcTemplate#batchUpdate(String, SqlParameterSource[]))
+ * @see NamedParameterJdbcTemplate#batchUpdate(String, SqlParameterSource[])
*/
@SuppressWarnings("unchecked")
public static SqlParameterSource[] createBatch(Object... candidates) {
@@ -58,7 +58,7 @@ public abstract class SqlParameterSourceUtils {
* @since 5.0.2
* @see MapSqlParameterSource
* @see BeanPropertySqlParameterSource
- * @see NamedParameterJdbcTemplate#batchUpdate(String, SqlParameterSource[]))
+ * @see NamedParameterJdbcTemplate#batchUpdate(String, SqlParameterSource[])
*/
@SuppressWarnings("unchecked")
public static SqlParameterSource[] createBatch(Collection> candidates) {
diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java
index e42e6d6440f..a9d913e9675 100644
--- a/spring-orm/src/main/java/org/springframework/orm/hibernate5/SessionFactoryUtils.java
+++ b/spring-orm/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.
@@ -133,7 +133,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 0e8716e088c..f286f1c2b07 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 ea7f5605f8c..c8fb2d5489b 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.
@@ -54,7 +54,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 38ee36f4b3e..071b0d6700e 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-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.
@@ -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 a7fcd3d56f7..98856256e79 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.
@@ -67,6 +67,7 @@ import org.springframework.util.Assert;
* not result in an exception.
*
* @author Sam Brannen
+ * @author Phillip Webb
* @since 3.2
* @see SmartContextLoader
*/
@@ -86,16 +87,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);
}
@@ -111,10 +109,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,9 +150,9 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte
@Override
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));
+ 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));
// If the original locations or classes were not empty, there's no
// need to bother with default detection checks; just let the
@@ -175,7 +173,7 @@ 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));
}
}
@@ -188,9 +186,8 @@ 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));
+ logger.info(String.format("%s detected default configuration classes for context configuration %s.",
+ name(getAnnotationConfigLoader()), configAttributes));
}
}
@@ -199,12 +196,12 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte
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);
}
}
}
@@ -235,8 +232,8 @@ public abstract class AbstractDelegatingSmartContextLoader implements SmartConte
List candidates = Arrays.asList(getXmlLoader(), getAnnotationConfigLoader());
Assert.state(!(mergedConfig.hasLocations() && mergedConfig.hasClasses()), () -> String.format(
- "Neither %s nor %s supports loading an ApplicationContext from %s: "
- + "declare either 'locations' or 'classes' but not both.", name(getXmlLoader()),
+ "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) {
@@ -256,34 +253,41 @@ 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, @Nullable 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.");
}
/**
* {@code AbstractDelegatingSmartContextLoader} does not support the
* {@link ContextLoader#loadContext(String...) } method. Call
* {@link #loadContext(MergedContextConfiguration)} instead.
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException in this implementation
*/
@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 e64d2658227..413c97b86b0 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-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.
@@ -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 83ee2ba5722..a4d68ecf00a 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 17600ec0510..f1a35bade1f 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:
- *
*
* - Calls {@link #validateMergedContextConfiguration(WebMergedContextConfiguration)}
* to allow subclasses to validate the supplied configuration before proceeding.
@@ -97,16 +95,15 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa
* - {@link ConfigurableApplicationContext#refresh Refreshes} the
* context and registers a JVM shutdown hook for it.
*
- *
* @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 {
- Assert.isTrue(mergedConfig instanceof WebMergedContextConfiguration, () -> String.format(
- "Cannot load WebApplicationContext from non-web merged context configuration %s. "
- + "Consider annotating your test class with @WebAppConfiguration.", mergedConfig));
+ Assert.isTrue(mergedConfig instanceof WebMergedContextConfiguration,
+ () -> String.format("Cannot load WebApplicationContext from non-web merged context configuration %s. " +
+ "Consider annotating your test class with @WebAppConfiguration.", mergedConfig));
WebMergedContextConfiguration webMergedConfig = (WebMergedContextConfiguration) mergedConfig;
@@ -150,20 +147,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
- *
*
* - The resource base path is retrieved from the supplied
* {@code WebMergedContextConfiguration}.
@@ -178,24 +170,20 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa
* {@link WebApplicationContext#ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE} key.
* - Finally, the {@code MockServletContext} is set in the
* {@code WebApplicationContext}.
- *
- * @param context the web application context for which to configure the web
- * resources
- * @param webMergedConfig the merged context configuration to use to load the
- * web application context
+ * @param context the web application context for which to configure the web resources
+ * @param webMergedConfig the merged context configuration to use to load the web application context
*/
protected void configureWebResources(GenericWebApplicationContext context,
WebMergedContextConfiguration webMergedConfig) {
ApplicationContext parent = context.getParent();
- // if the WAC has no parent or the parent is not a WAC, set the WAC as
- // the Root WAC:
+ // If the WebApplicationContext has no parent or the parent is not a WebApplicationContext,
+ // set the current context as the root WebApplicationContext:
if (parent == null || (!(parent instanceof WebApplicationContext))) {
String resourceBasePath = webMergedConfig.getResourceBasePath();
- ResourceLoader resourceLoader = resourceBasePath.startsWith(ResourceLoader.CLASSPATH_URL_PREFIX) ? new DefaultResourceLoader()
- : new FileSystemResourceLoader();
-
+ ResourceLoader resourceLoader = (resourceBasePath.startsWith(ResourceLoader.CLASSPATH_URL_PREFIX) ?
+ new DefaultResourceLoader() : new FileSystemResourceLoader());
ServletContext servletContext = new MockServletContext(resourceBasePath, resourceLoader);
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, context);
context.setServletContext(servletContext);
@@ -203,7 +191,7 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa
else {
ServletContext servletContext = null;
- // find the Root WAC
+ // Find the root WebApplicationContext
while (parent != null) {
if (parent instanceof WebApplicationContext && !(parent.getParent() instanceof WebApplicationContext)) {
servletContext = ((WebApplicationContext) parent).getServletContext();
@@ -219,10 +207,8 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa
/**
* Customize the internal bean factory of the {@code WebApplicationContext}
* created by this context loader.
- *
* The default implementation is empty but can be overridden in subclasses
* to customize {@code DefaultListableBeanFactory}'s standard settings.
- *
* @param beanFactory the bean factory created by this context loader
* @param webMergedConfig the merged context configuration to use to load the
* web application context
@@ -232,57 +218,55 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa
* @see DefaultListableBeanFactory#setAllowCircularReferences
* @see DefaultListableBeanFactory#setAllowRawInjectionDespiteWrapping
*/
- protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory,
- WebMergedContextConfiguration webMergedConfig) {
+ protected void customizeBeanFactory(
+ DefaultListableBeanFactory beanFactory, WebMergedContextConfiguration webMergedConfig) {
}
/**
* Load bean definitions into the supplied {@link GenericWebApplicationContext context}
* from the locations or classes in the supplied {@code WebMergedContextConfiguration}.
- *
*
Concrete subclasses must provide an appropriate implementation.
- *
* @param context the context into which the bean definitions should be loaded
* @param webMergedConfig the merged context configuration to use to load the
* web application context
* @see #loadContext(MergedContextConfiguration)
*/
- protected abstract void loadBeanDefinitions(GenericWebApplicationContext context,
- WebMergedContextConfiguration webMergedConfig);
+ protected abstract void loadBeanDefinitions(
+ GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig);
/**
* Customize the {@link GenericWebApplicationContext} created by this context
* loader after bean definitions have been loaded into the context but
* before the context is refreshed.
- *
*
The default implementation simply delegates to
* {@link AbstractContextLoader#customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)}.
- *
* @param context the newly created web application context
* @param webMergedConfig the merged context configuration to use to load the
* web application context
* @see #loadContext(MergedContextConfiguration)
* @see #customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)
*/
- protected void customizeContext(GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig) {
+ protected void customizeContext(
+ GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig) {
+
super.customizeContext(context, webMergedConfig);
}
- // --- ContextLoader -------------------------------------------------------
+
+ // ContextLoader
/**
* {@code AbstractGenericWebContextLoader} 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.
- *
* @see org.springframework.test.context.ContextLoader#loadContext(java.lang.String[])
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException in this implementation
*/
@Override
public final ApplicationContext loadContext(String... locations) throws Exception {
throw new UnsupportedOperationException(
- "AbstractGenericWebContextLoader does not support the loadContext(String... locations) method");
+ "AbstractGenericWebContextLoader does not support the loadContext(String... locations) method");
}
}
diff --git a/spring-test/src/main/java/org/springframework/test/context/web/AnnotationConfigWebContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/web/AnnotationConfigWebContextLoader.java
index 659574aeddd..3e99adbf532 100644
--- a/spring-test/src/main/java/org/springframework/test/context/web/AnnotationConfigWebContextLoader.java
+++ b/spring-test/src/main/java/org/springframework/test/context/web/AnnotationConfigWebContextLoader.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.
@@ -59,11 +59,10 @@ public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextL
private static final Log logger = LogFactory.getLog(AnnotationConfigWebContextLoader.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 {@linkplain
@@ -72,7 +71,6 @@ public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextL
* {@linkplain 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()
@@ -87,34 +85,31 @@ public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextL
/**
* 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}
+ * @return an array of default configuration classes, potentially empty but never {@code null}
* @see AnnotationConfigContextLoaderUtils
*/
protected Class>[] detectDefaultConfigurationClasses(Class> declaringClass) {
return AnnotationConfigContextLoaderUtils.detectDefaultConfigurationClasses(declaringClass);
}
- // --- AbstractContextLoader -----------------------------------------------
+
+ // AbstractContextLoader
/**
* {@code AnnotationConfigWebContextLoader} 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 org.springframework.test.context.support.AbstractContextLoader#modifyLocations
- * @throws UnsupportedOperationException
*/
@Override
protected String[] modifyLocations(Class> clazz, String... locations) {
throw new UnsupportedOperationException(
- "AnnotationConfigWebContextLoader does not support the modifyLocations(Class, String...) method");
+ "AnnotationConfigWebContextLoader does not support the modifyLocations(Class, String...) method");
}
/**
@@ -122,14 +117,13 @@ public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextL
* {@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 org.springframework.test.context.support.AbstractContextLoader#generateDefaultLocations
- * @throws UnsupportedOperationException
*/
@Override
protected String[] generateDefaultLocations(Class> clazz) {
throw new UnsupportedOperationException(
- "AnnotationConfigWebContextLoader does not support the generateDefaultLocations(Class) method");
+ "AnnotationConfigWebContextLoader does not support the generateDefaultLocations(Class) method");
}
/**
@@ -137,34 +131,32 @@ public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextL
* {@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 org.springframework.test.context.support.AbstractContextLoader#getResourceSuffix
- * @throws UnsupportedOperationException
*/
@Override
protected String getResourceSuffix() {
throw new UnsupportedOperationException(
- "AnnotationConfigWebContextLoader does not support the getResourceSuffix() method");
+ "AnnotationConfigWebContextLoader does not support the getResourceSuffix() method");
}
- // --- AbstractGenericWebContextLoader -------------------------------------
+
+ // AbstractGenericWebContextLoader
/**
* Register classes in the supplied {@linkplain GenericWebApplicationContext context}
* from the classes in the supplied {@link WebMergedContextConfiguration}.
- *
*
Each class must represent an annotated class. An
* {@link AnnotatedBeanDefinitionReader} is used to register the appropriate
* bean definitions.
- *
* @param context the context in which the annotated classes should be registered
* @param webMergedConfig the merged configuration from which the classes should be retrieved
- *
* @see AbstractGenericWebContextLoader#loadBeanDefinitions
*/
@Override
- protected void loadBeanDefinitions(GenericWebApplicationContext context,
- WebMergedContextConfiguration webMergedConfig) {
+ protected void loadBeanDefinitions(
+ GenericWebApplicationContext context, WebMergedContextConfiguration webMergedConfig) {
+
Class>[] annotatedClasses = webMergedConfig.getClasses();
if (logger.isDebugEnabled()) {
logger.debug("Registering annotated classes: " + ObjectUtils.nullSafeToString(annotatedClasses));
@@ -181,10 +173,10 @@ public class AnnotationConfigWebContextLoader extends AbstractGenericWebContextL
@Override
protected void validateMergedContextConfiguration(WebMergedContextConfiguration webMergedConfig) {
if (webMergedConfig.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.", webMergedConfig.getTestClass().getName(),
- ObjectUtils.nullSafeToString(webMergedConfig.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.",
+ webMergedConfig.getTestClass().getName(),
+ ObjectUtils.nullSafeToString(webMergedConfig.getLocations()), getClass().getSimpleName());
logger.error(msg);
throw new IllegalStateException(msg);
}
diff --git a/spring-test/src/main/java/org/springframework/test/context/web/GenericGroovyXmlWebContextLoader.java b/spring-test/src/main/java/org/springframework/test/context/web/GenericGroovyXmlWebContextLoader.java
index 93d2706950f..6f5e5273322 100644
--- a/spring-test/src/main/java/org/springframework/test/context/web/GenericGroovyXmlWebContextLoader.java
+++ b/spring-test/src/main/java/org/springframework/test/context/web/GenericGroovyXmlWebContextLoader.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.
@@ -38,7 +38,6 @@ public class GenericGroovyXmlWebContextLoader extends GenericXmlWebContextLoader
* Load bean definitions into the supplied {@link GenericWebApplicationContext context}
* from the locations in the supplied {@code WebMergedContextConfiguration} using a
* {@link GroovyBeanDefinitionReader}.
- *
* @param context the context into which the bean definitions should be loaded
* @param webMergedConfig the merged context configuration
* @see AbstractGenericWebContextLoader#loadBeanDefinitions
@@ -63,12 +62,12 @@ public class GenericGroovyXmlWebContextLoader extends GenericXmlWebContextLoader
* 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(
- "GenericGroovyXmlWebContextLoader does not support the getResourceSuffix() method");
+ "GenericGroovyXmlWebContextLoader does not support the getResourceSuffix() method");
}
}
diff --git a/spring-test/src/main/java/org/springframework/test/context/web/socket/MockServerContainer.java b/spring-test/src/main/java/org/springframework/test/context/web/socket/MockServerContainer.java
index bd7c725758e..3f0bfea9a7d 100644
--- a/spring-test/src/main/java/org/springframework/test/context/web/socket/MockServerContainer.java
+++ b/spring-test/src/main/java/org/springframework/test/context/web/socket/MockServerContainer.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.
@@ -45,7 +45,7 @@ class MockServerContainer implements ServerContainer {
private int defaultMaxTextMessageBufferSize;
- // --- WebSocketContainer --------------------------------------------------
+ // WebSocketContainer
@Override
public long getDefaultAsyncSendTimeout() {
@@ -119,7 +119,7 @@ class MockServerContainer implements ServerContainer {
}
- // --- ServerContainer -----------------------------------------------------
+ // ServerContainer
@Override
public void addEndpoint(Class> endpointClass) throws DeploymentException {
diff --git a/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java b/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java
index 3b7ae51037b..b8edcd9978b 100644
--- a/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.java
+++ b/spring-test/src/main/java/org/springframework/test/util/XpathExpectationsHelper.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.
@@ -63,7 +63,7 @@ public class XpathExpectationsHelper {
* @param namespaces XML namespaces referenced in the XPath expression, or {@code null}
* @param args arguments to parameterize the XPath expression with using the
* formatting specifiers defined in {@link String#format(String, Object...)}
- * @throws XPathExpressionException
+ * @throws XPathExpressionException if expression compilation failed
*/
public XpathExpectationsHelper(String expression, @Nullable Map namespaces, Object... args)
throws XPathExpressionException {
@@ -78,7 +78,7 @@ public class XpathExpectationsHelper {
throws XPathExpressionException {
SimpleNamespaceContext namespaceContext = new SimpleNamespaceContext();
- namespaceContext.setBindings((namespaces != null) ? namespaces : Collections. emptyMap());
+ namespaceContext.setBindings(namespaces != null ? namespaces : Collections.emptyMap());
XPath xpath = XPathFactory.newInstance().newXPath();
xpath.setNamespaceContext(namespaceContext);
return xpath.compile(expression);
@@ -122,7 +122,7 @@ public class XpathExpectationsHelper {
/**
* Apply the XPath expression to given document.
- * @throws XPathExpressionException
+ * @throws XPathExpressionException if expression evaluation failed
*/
@SuppressWarnings("unchecked")
@Nullable
diff --git a/spring-test/src/main/java/org/springframework/test/web/client/match/XpathRequestMatchers.java b/spring-test/src/main/java/org/springframework/test/web/client/match/XpathRequestMatchers.java
index e407ffe79b7..675c84bccc4 100644
--- a/spring-test/src/main/java/org/springframework/test/web/client/match/XpathRequestMatchers.java
+++ b/spring-test/src/main/java/org/springframework/test/web/client/match/XpathRequestMatchers.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.
@@ -18,7 +18,6 @@ package org.springframework.test.web.client.match;
import java.io.IOException;
import java.util.Map;
-
import javax.xml.xpath.XPathExpressionException;
import org.hamcrest.Matcher;
@@ -53,7 +52,7 @@ public class XpathRequestMatchers {
* @param namespaces XML namespaces referenced in the XPath expression, or {@code null}
* @param args arguments to parameterize the XPath expression with using the
* formatting specifiers defined in {@link String#format(String, Object...)}
- * @throws XPathExpressionException
+ * @throws XPathExpressionException if expression compilation failed
*/
protected XpathRequestMatchers(String expression, @Nullable Map namespaces, Object ... args)
throws XPathExpressionException {
diff --git a/spring-tx/src/main/java/org/springframework/transaction/support/AbstractTransactionStatus.java b/spring-tx/src/main/java/org/springframework/transaction/support/AbstractTransactionStatus.java
index 038c15fd6c7..c7d0e84fd01 100644
--- a/spring-tx/src/main/java/org/springframework/transaction/support/AbstractTransactionStatus.java
+++ b/spring-tx/src/main/java/org/springframework/transaction/support/AbstractTransactionStatus.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.
@@ -184,7 +184,7 @@ public abstract class AbstractTransactionStatus implements TransactionStatus {
* This implementation delegates to a SavepointManager for the
* underlying transaction, if possible.
* @see #getSavepointManager()
- * @see org.springframework.transaction.SavepointManager
+ * @see SavepointManager#createSavepoint()
*/
@Override
public Object createSavepoint() throws TransactionException {
@@ -194,9 +194,8 @@ public abstract class AbstractTransactionStatus implements TransactionStatus {
/**
* This implementation delegates to a SavepointManager for the
* underlying transaction, if possible.
- * @throws org.springframework.transaction.NestedTransactionNotSupportedException
* @see #getSavepointManager()
- * @see org.springframework.transaction.SavepointManager
+ * @see SavepointManager#rollbackToSavepoint(Object)
*/
@Override
public void rollbackToSavepoint(Object savepoint) throws TransactionException {
@@ -207,7 +206,7 @@ public abstract class AbstractTransactionStatus implements TransactionStatus {
* This implementation delegates to a SavepointManager for the
* underlying transaction, if possible.
* @see #getSavepointManager()
- * @see org.springframework.transaction.SavepointManager
+ * @see SavepointManager#releaseSavepoint(Object)
*/
@Override
public void releaseSavepoint(Object savepoint) throws TransactionException {
diff --git a/spring-web/src/main/java/org/springframework/http/CacheControl.java b/spring-web/src/main/java/org/springframework/http/CacheControl.java
index 2e8ce692f80..ba092ee53f6 100644
--- a/spring-web/src/main/java/org/springframework/http/CacheControl.java
+++ b/spring-web/src/main/java/org/springframework/http/CacheControl.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.
@@ -83,7 +83,8 @@ public class CacheControl {
/**
* Return an empty directive.
- * This is well suited for using other optional directives without "max-age", "no-cache" or "no-store".
+ *
This is well suited for using other optional directives without "max-age",
+ * "no-cache" or "no-store".
* @return {@code this}, to facilitate method chaining
*/
public static CacheControl empty() {
@@ -92,11 +93,13 @@ public class CacheControl {
/**
* Add a "max-age=" directive.
- *
This directive is well suited for publicly caching resources, knowing that they won't change within
- * the configured amount of time. Additional directives can be also used, in case resources shouldn't be
- * cached ({@link #cachePrivate()}) or transformed ({@link #noTransform()}) by shared caches.
- *
In order to prevent caches to reuse the cached response even when it has become stale
- * (i.e. the "max-age" delay is passed), the "must-revalidate" directive should be set ({@link #mustRevalidate()}
+ *
This directive is well suited for publicly caching resources, knowing that
+ * they won't change within the configured amount of time. Additional directives
+ * can be also used, in case resources shouldn't be cached ({@link #cachePrivate()})
+ * or transformed ({@link #noTransform()}) by shared caches.
+ *
In order to prevent caches to reuse the cached response even when it has
+ * become stale (i.e. the "max-age" delay is passed), the "must-revalidate"
+ * directive should be set ({@link #mustRevalidate()}
* @param maxAge the maximum time the response should be cached
* @param unit the time unit of the {@code maxAge} argument
* @return {@code this}, to facilitate method chaining
@@ -110,12 +113,13 @@ public class CacheControl {
/**
* Add a "no-cache" directive.
- *
This directive is well suited for telling caches that the response can be reused only if the client
- * revalidates it with the server. This directive won't disable cache altogether and may result with
- * clients sending conditional requests (with "ETag", "If-Modified-Since" headers) and the server responding
- * with "304 - Not Modified" status.
- *
In order to disable caching and minimize requests/responses exchanges, the {@link #noStore()} directive
- * should be used instead of {@link #noCache()}.
+ *
This directive is well suited for telling caches that the response
+ * can be reused only if the client revalidates it with the server.
+ * This directive won't disable cache altogether and may result with clients
+ * sending conditional requests (with "ETag", "If-Modified-Since" headers)
+ * and the server responding with "304 - Not Modified" status.
+ *
In order to disable caching and minimize requests/responses exchanges,
+ * the {@link #noStore()} directive should be used instead of {@code #noCache()}.
* @return {@code this}, to facilitate method chaining
* @see rfc7234 section 5.2.2.2
*/
@@ -127,7 +131,8 @@ public class CacheControl {
/**
* Add a "no-store" directive.
- *
This directive is well suited for preventing caches (browsers and proxies) to cache the content of responses.
+ *
This directive is well suited for preventing caches (browsers and proxies)
+ * to cache the content of responses.
* @return {@code this}, to facilitate method chaining
* @see rfc7234 section 5.2.2.3
*/
@@ -140,8 +145,9 @@ public class CacheControl {
/**
* Add a "must-revalidate" directive.
- *
This directive indicates that once it has become stale, a cache MUST NOT use the response
- * to satisfy subsequent requests without successful validation on the origin server.
+ *
This directive indicates that once it has become stale, a cache MUST NOT
+ * use the response to satisfy subsequent requests without successful validation
+ * on the origin server.
* @return {@code this}, to facilitate method chaining
* @see rfc7234 section 5.2.2.1
*/
@@ -152,8 +158,9 @@ public class CacheControl {
/**
* Add a "no-transform" directive.
- *
This directive indicates that intermediaries (caches and others) should not transform the response content.
- * This can be useful to force caches and CDNs not to automatically gzip or optimize the response content.
+ *
This directive indicates that intermediaries (caches and others) should
+ * not transform the response content. This can be useful to force caches and
+ * CDNs not to automatically gzip or optimize the response content.
* @return {@code this}, to facilitate method chaining
* @see rfc7234 section 5.2.2.4
*/
@@ -164,8 +171,9 @@ public class CacheControl {
/**
* Add a "public" directive.
- *
This directive indicates that any cache MAY store the response, even if the response
- * would normally be non-cacheable or cacheable only within a private cache.
+ *
This directive indicates that any cache MAY store the response,
+ * even if the response would normally be non-cacheable or cacheable
+ * only within a private cache.
* @return {@code this}, to facilitate method chaining
* @see rfc7234 section 5.2.2.5
*/
@@ -176,8 +184,8 @@ public class CacheControl {
/**
* Add a "private" directive.
- *
This directive indicates that the response message is intended for a single user
- * and MUST NOT be stored by a shared cache.
+ *
This directive indicates that the response message is intended
+ * for a single user and MUST NOT be stored by a shared cache.
* @return {@code this}, to facilitate method chaining
* @see rfc7234 section 5.2.2.6
*/
@@ -200,8 +208,8 @@ public class CacheControl {
/**
* Add an "s-maxage" directive.
- *
This directive indicates that, in shared caches, the maximum age specified by this directive
- * overrides the maximum age specified by other directives.
+ *
This directive indicates that, in shared caches, the maximum age specified
+ * by this directive overrides the maximum age specified by other directives.
* @param sMaxAge the maximum time the response should be cached
* @param unit the time unit of the {@code sMaxAge} argument
* @return {@code this}, to facilitate method chaining
@@ -214,10 +222,11 @@ public class CacheControl {
/**
* Add a "stale-while-revalidate" directive.
- *
This directive indicates that caches MAY serve the response in
- * which it appears after it becomes stale, up to the indicated number of seconds.
+ *
This directive indicates that caches MAY serve the response in which it
+ * appears after it becomes stale, up to the indicated number of seconds.
* If a cached response is served stale due to the presence of this extension,
- * the cache SHOULD attempt to revalidate it while still serving stale responses (i.e., without blocking).
+ * the cache SHOULD attempt to revalidate it while still serving stale responses
+ * (i.e. without blocking).
* @param staleWhileRevalidate the maximum time the response should be used while being revalidated
* @param unit the time unit of the {@code staleWhileRevalidate} argument
* @return {@code this}, to facilitate method chaining
@@ -230,8 +239,8 @@ public class CacheControl {
/**
* Add a "stale-if-error" directive.
- *
This directive indicates that when an error is encountered, a cached stale response MAY be used to satisfy
- * the request, regardless of other freshness information.
+ *
This directive indicates that when an error is encountered, a cached stale response
+ * MAY be used to satisfy the request, regardless of other freshness information.
* @param staleIfError the maximum time the response should be used when errors are encountered
* @param unit the time unit of the {@code staleIfError} argument
* @return {@code this}, to facilitate method chaining
diff --git a/spring-web/src/main/java/org/springframework/http/codec/ClientCodecConfigurer.java b/spring-web/src/main/java/org/springframework/http/codec/ClientCodecConfigurer.java
index 2866b2386d4..63fe8e6bd30 100644
--- a/spring-web/src/main/java/org/springframework/http/codec/ClientCodecConfigurer.java
+++ b/spring-web/src/main/java/org/springframework/http/codec/ClientCodecConfigurer.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.
@@ -48,7 +48,7 @@ public interface ClientCodecConfigurer extends CodecConfigurer {
/**
- * Extension of {@link DefaultCodecs} with extra client options.
+ * Extension of {@link CodecConfigurer.DefaultCodecs} with extra client options.
*/
interface ClientDefaultCodecs extends DefaultCodecs {
diff --git a/spring-web/src/main/java/org/springframework/http/codec/ServerCodecConfigurer.java b/spring-web/src/main/java/org/springframework/http/codec/ServerCodecConfigurer.java
index cb2412e4a61..f1386b4bdba 100644
--- a/spring-web/src/main/java/org/springframework/http/codec/ServerCodecConfigurer.java
+++ b/spring-web/src/main/java/org/springframework/http/codec/ServerCodecConfigurer.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.
@@ -47,7 +47,7 @@ public interface ServerCodecConfigurer extends CodecConfigurer {
/**
- * Extension of {@link DefaultCodecs} with extra server options.
+ * Extension of {@link CodecConfigurer.DefaultCodecs} with extra server options.
*/
interface ServerDefaultCodecs extends DefaultCodecs {
diff --git a/spring-web/src/main/java/org/springframework/remoting/jaxws/LocalJaxWsServiceFactory.java b/spring-web/src/main/java/org/springframework/remoting/jaxws/LocalJaxWsServiceFactory.java
index 0d24b44f5ee..413f9b59548 100644
--- a/spring-web/src/main/java/org/springframework/remoting/jaxws/LocalJaxWsServiceFactory.java
+++ b/spring-web/src/main/java/org/springframework/remoting/jaxws/LocalJaxWsServiceFactory.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.
@@ -73,11 +73,10 @@ public class LocalJaxWsServiceFactory {
/**
* Set the WSDL document URL as a {@link Resource}.
- * @throws IOException
* @since 3.2
*/
public void setWsdlDocumentResource(Resource wsdlDocumentResource) throws IOException {
- Assert.notNull(wsdlDocumentResource, "WSDL Resource must not be null.");
+ Assert.notNull(wsdlDocumentResource, "WSDL Resource must not be null");
this.wsdlDocumentUrl = wsdlDocumentResource.getURL();
}
diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/AbstractHandlerMethodMapping.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/AbstractHandlerMethodMapping.java
index 888f7b15dc4..8efebf79335 100644
--- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/AbstractHandlerMethodMapping.java
+++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/AbstractHandlerMethodMapping.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.
@@ -292,19 +292,17 @@ public abstract class AbstractHandlerMethodMapping extends AbstractHandlerMap
* If multiple matches are found, the best match is selected.
* @param exchange the current exchange
* @return the best-matching handler method, or {@code null} if no match
- * @see #handleMatch(T, HandlerMethod, ServerWebExchange)
- * @see #handleNoMatch(Set, ServerWebExchange)
+ * @see #handleMatch
+ * @see #handleNoMatch
*/
@Nullable
- protected HandlerMethod lookupHandlerMethod(ServerWebExchange exchange)
- throws Exception {
-
+ protected HandlerMethod lookupHandlerMethod(ServerWebExchange exchange) throws Exception {
List matches = new ArrayList<>();
addMatchingMappings(this.mappingRegistry.getMappings().keySet(), matches, exchange);
if (!matches.isEmpty()) {
Comparator comparator = new MatchComparator(getMappingComparator(exchange));
- Collections.sort(matches, comparator);
+ matches.sort(comparator);
if (logger.isTraceEnabled()) {
logger.trace("Found " + matches.size() + " matching mapping(s) for [" +
exchange.getRequest().getPath() + "] : " + matches);
diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/MatrixVariableMapMethodArgumentResolver.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/MatrixVariableMapMethodArgumentResolver.java
index 66c68ca9ed1..8476b27f01d 100644
--- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/MatrixVariableMapMethodArgumentResolver.java
+++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/method/annotation/MatrixVariableMapMethodArgumentResolver.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.
@@ -13,6 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
package org.springframework.web.reactive.result.method.annotation;
import java.util.Collections;
@@ -37,14 +38,13 @@ import org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentR
import org.springframework.web.server.ServerWebExchange;
/**
- * Resolves arguments of type {@link Map} annotated with {@link MatrixVariable
- * @MatrixVariable} where the annotation does not specify a name. In other words
- * the purpose of this resolver is to provide access to multiple matrix
- * variables, either all or associted with a specific path variable.
+ * Resolves arguments of type {@link Map} annotated with {@link MatrixVariable @MatrixVariable}
+ * where the annotation does not specify a name. In other words the purpose of this resolver
+ * is to provide access to multiple matrix variables, either all or associted with a specific
+ * path variable.
*
- * When a name is specified, an argument of type Map is considered to be an
- * single attribute with a Map value, and is resolved by
- * {@link MatrixVariableMethodArgumentResolver} instead.
+ *
When a name is specified, an argument of type Map is considered to be a single attribute
+ * with a Map value, and is resolved by {@link MatrixVariableMethodArgumentResolver} instead.
*
* @author Rossen Stoyanchev
* @since 5.0.1
diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java
index c61b0e24f78..5ea0176ca63 100644
--- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java
+++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RedirectView.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.
@@ -142,9 +142,8 @@ public class RedirectView extends AbstractUrlBasedView {
/**
* Configure one or more hosts associated with the application.
* All other hosts will be considered external hosts.
- *
In effect this provides a way turn off encoding via
- * {@link ServerHttpResponse#encodeUrl(String)} for URLs that have a
- * host and that host is not listed as a known host.
+ *
In effect this provides a way turn off encoding for URLs that
+ * have a host and that host is not listed as a known host.
*
If not set (the default) all redirect URLs are encoded.
* @param hosts one or more application hosts
*/
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MatrixVariableMapMethodArgumentResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MatrixVariableMapMethodArgumentResolver.java
index daaa094a327..d1407e71298 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MatrixVariableMapMethodArgumentResolver.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MatrixVariableMapMethodArgumentResolver.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.
@@ -38,14 +38,13 @@ import org.springframework.web.method.support.ModelAndViewContainer;
import org.springframework.web.servlet.HandlerMapping;
/**
- * Resolves arguments of type {@link Map} annotated with {@link MatrixVariable
- * @MatrixVariable} where the annotation does not specify a name. In other words
- * the purpose of this resolver is to provide access to multiple matrix
- * variables, either all or associted with a specific path variable.
+ * Resolves arguments of type {@link Map} annotated with {@link MatrixVariable @MatrixVariable}
+ * where the annotation does not specify a name. In other words the purpose of this resolver
+ * is to provide access to multiple matrix variables, either all or associted with a specific
+ * path variable.
*
- *
When a name is specified, an argument of type Map is considered to be an
- * single attribute with a Map value, and is resolved by
- * {@link MatrixVariableMethodArgumentResolver} instead.
+ *
When a name is specified, an argument of type Map is considered to be a single attribute
+ * with a Map value, and is resolved by {@link MatrixVariableMethodArgumentResolver} instead.
*
* @author Rossen Stoyanchev
* @since 3.2
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/LabelTag.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/LabelTag.java
index a805ad902c0..b74c9271799 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/LabelTag.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/LabelTag.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.
@@ -233,7 +233,7 @@ public class LabelTag extends AbstractHtmlElementTag {
}
/**
- * Overrides {@link #getName()} to always return {@code null},
+ * Overrides {@code #getName()} to always return {@code null},
* because the '{@code name}' attribute is not supported by the
* '{@code label}' tag.
* @return the value for the HTML '{@code name}' attribute