From caad4372484c0feeff20d4e690d557c129dc6f12 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Sun, 3 Apr 2011 15:26:13 +0000 Subject: [PATCH] polishing JavaDoc git-svn-id: https://src.springframework.org/svn/spring-framework/trunk@4160 50f2f4bb-b051-0410-bef5-90022cba6387 --- .../test/context/TestContext.java | 36 +++++-------------- 1 file changed, 8 insertions(+), 28 deletions(-) diff --git a/org.springframework.test/src/main/java/org/springframework/test/context/TestContext.java b/org.springframework.test/src/main/java/org/springframework/test/context/TestContext.java index 5aad555af4a..77dd4a901ec 100644 --- a/org.springframework.test/src/main/java/org/springframework/test/context/TestContext.java +++ b/org.springframework.test/src/main/java/org/springframework/test/context/TestContext.java @@ -79,15 +79,12 @@ public class TestContext extends AttributeAccessorSupport { * and {@link ContextCache context cache} and parse the corresponding * {@link ContextConfiguration @ContextConfiguration} annotation, if * present. - *

- * If the supplied class name for the default ContextLoader is + *

If the supplied class name for the default ContextLoader is * null or empty and no ContextLoader * class is explicitly supplied via the * @ContextConfiguration annotation, a * {@link org.springframework.test.context.support.GenericXmlContextLoader * GenericXmlContextLoader} will be used instead. - *

- * * @param testClass the test class for which the test context should be * constructed (must not be null) * @param contextCache the context cache from which the constructed test @@ -132,7 +129,6 @@ public class TestContext extends AttributeAccessorSupport { } /** - *

* Retrieve the {@link ContextLoader} {@link Class} to use for the supplied * {@link Class test class}. *

    @@ -146,14 +142,11 @@ public class TestContext extends AttributeAccessorSupport { * the class hierarchy, an attempt will be made to load and return the class * with the supplied defaultContextLoaderClassName. *
- * * @param clazz the class for which to retrieve ContextLoader * class; must not be null * @param defaultContextLoaderClassName the name of the default - * ContextLoader class to use; must not be null or - * empty - * @return the ContextLoader class to use for the specified - * class + * ContextLoader class to use; must not be null or empty + * @return the ContextLoader class to use for the specified class * @throws IllegalArgumentException if {@link ContextConfiguration * @ContextConfiguration} is not present on the supplied class */ @@ -209,14 +202,12 @@ public class TestContext extends AttributeAccessorSupport { * {@link Class class}, using the supplied {@link ContextLoader} to * {@link ContextLoader#processLocations(Class, String...) process} the * locations. - *

- * Note that the {@link ContextConfiguration#inheritLocations() + *

Note that the {@link ContextConfiguration#inheritLocations() * inheritLocations} flag of {@link ContextConfiguration * @ContextConfiguration} will be taken into consideration. * Specifically, if the inheritLocations flag is set to * true, locations defined in the annotated class will be * appended to the locations defined in superclasses. - * * @param contextLoader the ContextLoader to use for processing the * locations (must not be null) * @param clazz the class for which to retrieve the resource locations (must @@ -299,9 +290,7 @@ public class TestContext extends AttributeAccessorSupport { /** * Load an ApplicationContext for this test context using the * configured ContextLoader and resource locations. - * - * @throws Exception if an error occurs while loading the application - * context + * @throws Exception if an error occurs while loading the application context */ private ApplicationContext loadApplicationContext() throws Exception { Assert.notNull(this.contextLoader, "Can not load an ApplicationContext with a NULL 'contextLoader'. " @@ -322,7 +311,6 @@ public class TestContext extends AttributeAccessorSupport { /** * Get the {@link ApplicationContext application context} for this test * context, possibly cached. - * * @return the application context * @throws IllegalStateException if an error occurs while retrieving the * application context @@ -345,7 +333,6 @@ public class TestContext extends AttributeAccessorSupport { /** * Get the {@link Class test class} for this test context. - * * @return the test class (never null) */ public final Class getTestClass() { @@ -354,9 +341,7 @@ public class TestContext extends AttributeAccessorSupport { /** * Get the current {@link Object test instance} for this test context. - *

- * Note: this is a mutable property. - * + *

Note: this is a mutable property. * @return the current test instance (may be null) * @see #updateState(Object,Method,Throwable) */ @@ -366,9 +351,7 @@ public class TestContext extends AttributeAccessorSupport { /** * Get the current {@link Method test method} for this test context. - *

- * Note: this is a mutable property. - * + *

Note: this is a mutable property. * @return the current test method (may be null) * @see #updateState(Object, Method, Throwable) */ @@ -379,9 +362,7 @@ public class TestContext extends AttributeAccessorSupport { /** * Get the {@link Throwable exception} that was thrown during execution of * the {@link #getTestMethod() test method}. - *

- * Note: this is a mutable property. - * + *

Note: this is a mutable property. * @return the exception that was thrown, or null if no * exception was thrown * @see #updateState(Object, Method, Throwable) @@ -403,7 +384,6 @@ public class TestContext extends AttributeAccessorSupport { /** * Update this test context to reflect the state of the currently executing * test. - * * @param testInstance the current test instance (may be null) * @param testMethod the current test method (may be null) * @param testException the exception that was thrown in the test method, or