Polishing

Author: jhoeller

spring-test/src/main/java/org/springframework/test/context/ContextConfiguration.java

@@ -90,10 +90,8 @@
 
 	/**
 	 * Alias for {@link #locations}.
-	 *
 	 * <p>This attribute may <strong>not</strong> be used in conjunction with
 	 * {@link #locations}, but it may be used instead of {@link #locations}.
-	 *
 	 * @since 3.0
 	 * @see #inheritLocations
 	 */
@@ -102,7 +100,6 @@
 	/**
 	 * The resource locations to use for loading an
 	 * {@link org.springframework.context.ApplicationContext ApplicationContext}.
-	 *
 	 * <p>Check out the Javadoc for
 	 * {@link org.springframework.test.context.support.AbstractContextLoader#modifyLocations
 	 * AbstractContextLoader.modifyLocations()} for details on how a location
@@ -111,7 +108,6 @@
 	 * {@link org.springframework.test.context.support.AbstractContextLoader#generateDefaultLocations
 	 * AbstractContextLoader.generateDefaultLocations()} for details on the
 	 * default locations that are going to be used if none are specified.
-	 *
 	 * <p>Note that the aforementioned default rules only apply for a standard
 	 * {@link org.springframework.test.context.support.AbstractContextLoader
 	 * AbstractContextLoader} subclass such as
@@ -120,10 +116,8 @@
 	 * which are the effective default implementations used at runtime if
 	 * {@code locations} are configured. See the documentation for {@link #loader}
 	 * for further details regarding default loaders.
-	 *
 	 * <p>This attribute may <strong>not</strong> be used in conjunction with
 	 * {@link #value}, but it may be used instead of {@link #value}.
-	 *
 	 * @since 2.5
 	 * @see #inheritLocations
 	 */
@@ -132,14 +126,12 @@
 	/**
 	 * The <em>annotated classes</em> to use for loading an
 	 * {@link org.springframework.context.ApplicationContext ApplicationContext}.
-	 *
-	 * <p>Check out the Javadoc for
+	 * <p>Check out the javadoc for
 	 * {@link org.springframework.test.context.support.AnnotationConfigContextLoader#detectDefaultConfigurationClasses
 	 * AnnotationConfigContextLoader.detectDefaultConfigurationClasses()} for details
 	 * on how default configuration classes will be detected if no
 	 * <em>annotated classes</em> are specified. See the documentation for
 	 * {@link #loader} for further details regarding default loaders.
-	 *
 	 * @since 3.1
 	 * @see org.springframework.context.annotation.Configuration
 	 * @see org.springframework.test.context.support.AnnotationConfigContextLoader
@@ -150,16 +142,13 @@
 	/**
 	 * The application context <em>initializer classes</em> to use for initializing
 	 * a {@link ConfigurableApplicationContext}.
-	 *
 	 * <p>The concrete {@code ConfigurableApplicationContext} type supported by each
 	 * declared initializer must be compatible with the type of {@code ApplicationContext}
 	 * created by the {@link SmartContextLoader} in use.
-	 *
 	 * <p>{@code SmartContextLoader} implementations typically detect whether
 	 * Spring's {@link org.springframework.core.Ordered Ordered} interface has been
 	 * implemented or if the @{@link org.springframework.core.annotation.Order Order}
 	 * annotation is present and sort instances accordingly prior to invoking them.
-	 *
 	 * @since 3.2
 	 * @see org.springframework.context.ApplicationContextInitializer
 	 * @see org.springframework.context.ConfigurableApplicationContext
@@ -171,20 +160,17 @@
 	/**
 	 * Whether or not {@link #locations resource locations} or <em>annotated
 	 * classes</em> from test superclasses should be <em>inherited</em>.
-	 *
 	 * <p>The default value is {@code true}. This means that an annotated
 	 * class will <em>inherit</em> the resource locations or annotated classes
 	 * defined by test superclasses. Specifically, the resource locations or
 	 * annotated classes for a given test class will be appended to the list of
 	 * resource locations or annotated classes defined by test superclasses.
 	 * Thus, subclasses have the option of <em>extending</em> the list of resource
 	 * locations or annotated classes.
-	 *
 	 * <p>If {@code inheritLocations} is set to {@code false}, the
 	 * resource locations or annotated classes for the annotated class
 	 * will <em>shadow</em> and effectively replace any resource locations
 	 * or annotated classes defined by superclasses.
-	 *
 	 * <p>In the following example that uses path-based resource locations, the
 	 * {@link org.springframework.context.ApplicationContext ApplicationContext}
 	 * for {@code ExtendedTest} will be loaded from
@@ -203,7 +189,6 @@
 	 *     // ...
 	 * }
 	 * </pre>
-	 *
 	 * <p>Similarly, in the following example that uses annotated
 	 * classes, the
 	 * {@link org.springframework.context.ApplicationContext ApplicationContext}
@@ -230,18 +215,15 @@
 	/**
 	 * Whether or not {@linkplain #initializers context initializers} from test
 	 * superclasses should be <em>inherited</em>.
-	 *
 	 * <p>The default value is {@code true}. This means that an annotated
 	 * class will <em>inherit</em> the application context initializers defined
 	 * by test superclasses. Specifically, the initializers for a given test
 	 * class will be added to the set of initializers defined by test
 	 * superclasses. Thus, subclasses have the option of <em>extending</em> the
 	 * set of initializers.
-	 *
 	 * <p>If {@code inheritInitializers} is set to {@code false}, the
 	 * initializers for the annotated class will <em>shadow</em> and effectively
 	 * replace any initializers defined by superclasses.
-	 *
 	 * <p>In the following example, the
 	 * {@link org.springframework.context.ApplicationContext ApplicationContext}
 	 * for {@code ExtendedTest} will be initialized using
@@ -269,12 +251,10 @@
 	 * The type of {@link SmartContextLoader} (or {@link ContextLoader}) to use
 	 * for loading an {@link org.springframework.context.ApplicationContext
 	 * ApplicationContext}.
-	 *
 	 * <p>If not specified, the loader will be inherited from the first superclass
 	 * that is annotated with {@code @ContextConfiguration} and specifies an
 	 * explicit loader. If no class in the hierarchy specifies an explicit
 	 * loader, a default loader will be used instead.
-	 *
 	 * <p>The default concrete implementation chosen at runtime will be either
 	 * {@link org.springframework.test.context.support.DelegatingSmartContextLoader
 	 * DelegatingSmartContextLoader} or
@@ -290,23 +270,19 @@
 	 * {@link org.springframework.test.context.web.GenericXmlWebContextLoader GenericXmlWebContextLoader},
 	 * {@link org.springframework.test.context.web.GenericGroovyXmlWebContextLoader GenericGroovyXmlWebContextLoader}, and
 	 * {@link org.springframework.test.context.web.AnnotationConfigWebContextLoader AnnotationConfigWebContextLoader}.
-	 *
 	 * @since 2.5
 	 */
 	Class<? extends ContextLoader> loader() default ContextLoader.class;
 
 	/**
 	 * The name of the context hierarchy level represented by this configuration.
-	 *
 	 * <p>If not specified the name will be inferred based on the numerical level
 	 * within all declared contexts within the hierarchy.
-	 *
 	 * <p>This attribute is only applicable when used within a test class hierarchy
 	 * that is configured using {@code @ContextHierarchy}, in which case the name
 	 * can be used for <em>merging</em> or <em>overriding</em> this configuration
 	 * with configuration of the same name in hierarchy levels defined in superclasses.
 	 * See the Javadoc for {@link ContextHierarchy @ContextHierarchy} for details.
-	 *
 	 * @since 3.2.2
 	 */
 	String name() default "";

spring-test/src/main/java/org/springframework/test/context/ContextHierarchy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -148,7 +148,6 @@
 	/**
 	 * A list of {@link ContextConfiguration @ContextConfiguration} instances,
 	 * each of which defines a level in the context hierarchy.
-	 *
 	 * <p>If you need to merge or override the configuration for a given level
 	 * of the context hierarchy within a test class hierarchy, you must explicitly
 	 * name that level by supplying the same value to the {@link ContextConfiguration#name

spring-test/src/main/java/org/springframework/test/context/ContextLoader.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2015 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,8 +33,7 @@
  * The results of {@link #processLocations(Class, String...) processLocations()}
  * should then be supplied to {@link #loadContext(String...) loadContext()}.
  *
- * <p>Concrete implementations must provide a {@code public} no-args
- * constructor.
+ * <p>Concrete implementations must provide a {@code public} no-args constructor.
  *
  * <p>Spring provides the following out-of-the-box implementations:
  * <ul>
@@ -52,10 +51,8 @@ public interface ContextLoader {
 
 	/**
 	 * Processes application context resource locations for a specified class.
-	 *
 	 * <p>Concrete implementations may choose to modify the supplied locations,
 	 * generate new locations, or simply return the supplied locations unchanged.
-	 *
 	 * @param clazz the class with which the locations are associated: used to
 	 * determine how to process the supplied locations
 	 * @param locations the unmodified locations to use for loading the
@@ -68,24 +65,20 @@ public interface ContextLoader {
 	 * Loads a new {@link ApplicationContext context} based on the supplied
 	 * {@code locations}, configures the context, and finally returns
 	 * the context in fully <em>refreshed</em> state.
-	 *
 	 * <p>Configuration locations are generally considered to be classpath
 	 * resources by default.
-	 *
 	 * <p>Concrete implementations should register annotation configuration
 	 * processors with bean factories of {@link ApplicationContext application
 	 * contexts} loaded by this ContextLoader. Beans will therefore automatically
 	 * be candidates for annotation-based dependency injection using
 	 * {@link org.springframework.beans.factory.annotation.Autowired @Autowired},
 	 * {@link javax.annotation.Resource @Resource}, and
 	 * {@link javax.inject.Inject @Inject}.
-	 *
 	 * <p>Any ApplicationContext loaded by a ContextLoader <strong>must</strong>
 	 * register a JVM shutdown hook for itself. Unless the context gets closed
 	 * early, all context instances will be automatically closed on JVM
 	 * shutdown. This allows for freeing external resources held by beans within
 	 * the context, e.g. temporary files.
-	 *
 	 * @param locations the resource locations to use to load the application context
 	 * @return a new application context
 	 * @throws Exception if context loading failed