Skip to content

Commit 3210041

Browse files
committed
Improve Javadoc for ContextLoaderUtils
- class-level Javadoc now mentions application context initializers. - avoided and suppressed warnings in method-level Javadoc. Issue: SPR-10232
1 parent ac88106 commit 3210041

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2012 the original author or authors.
2+
* Copyright 2002-2013 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -41,7 +41,8 @@
4141
/**
4242
* Utility methods for working with {@link ContextLoader ContextLoaders} and
4343
* {@link SmartContextLoader SmartContextLoaders} and resolving resource locations,
44-
* annotated classes, and active bean definition profiles.
44+
* annotated classes, active bean definition profiles, and application context
45+
* initializers.
4546
*
4647
* @author Sam Brannen
4748
* @since 3.1
@@ -50,6 +51,7 @@
5051
* @see ContextConfiguration
5152
* @see ContextConfigurationAttributes
5253
* @see ActiveProfiles
54+
* @see ApplicationContextInitializer
5355
* @see MergedContextConfiguration
5456
*/
5557
abstract class ContextLoaderUtils {
@@ -78,7 +80,7 @@ private ContextLoaderUtils() {
7880
* either {@value #DEFAULT_CONTEXT_LOADER_CLASS_NAME}
7981
* or {@value #DEFAULT_WEB_CONTEXT_LOADER_CLASS_NAME} will be used as the
8082
* default context loader class name. For details on the class resolution
81-
* process, see {@link #resolveContextLoaderClass()}.
83+
* process, see {@link #resolveContextLoaderClass}.
8284
*
8385
* @param testClass the test class for which the {@code ContextLoader}
8486
* should be resolved; must not be {@code null}
@@ -89,8 +91,9 @@ private ContextLoaderUtils() {
8991
* {@code ContextLoader} class to use; may be {@code null} or <em>empty</em>
9092
* @return the resolved {@code ContextLoader} for the supplied
9193
* {@code testClass} (never {@code null})
92-
* @see #resolveContextLoaderClass()
94+
* @see #resolveContextLoaderClass
9395
*/
96+
@SuppressWarnings("javadoc")
9497
static ContextLoader resolveContextLoader(Class<?> testClass,
9598
List<ContextConfigurationAttributes> configAttributesList, String defaultContextLoaderClassName) {
9699
Assert.notNull(testClass, "Class must not be null");
@@ -348,11 +351,11 @@ else if (!ObjectUtils.isEmpty(valueProfiles)) {
348351
* @param defaultContextLoaderClassName the name of the default
349352
* {@code ContextLoader} class to use (may be {@code null})
350353
* @return the merged context configuration
351-
* @see #resolveContextLoader()
352-
* @see #resolveContextConfigurationAttributes()
353-
* @see SmartContextLoader#processContextConfiguration()
354-
* @see ContextLoader#processLocations()
355-
* @see #resolveActiveProfiles()
354+
* @see #resolveContextLoader
355+
* @see #resolveContextConfigurationAttributes
356+
* @see SmartContextLoader#processContextConfiguration
357+
* @see ContextLoader#processLocations
358+
* @see #resolveActiveProfiles
356359
* @see MergedContextConfiguration
357360
*/
358361
static MergedContextConfiguration buildMergedContextConfiguration(Class<?> testClass,

0 commit comments

Comments
 (0)