Browse Source

Polish Javadoc for TestExecutionListener

pull/600/head
Sam Brannen 11 years ago
parent
commit
97dad7e2ea
  1. 41
      spring-test/src/main/java/org/springframework/test/context/TestExecutionListener.java

41
spring-test/src/main/java/org/springframework/test/context/TestExecutionListener.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2014 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -20,21 +20,21 @@ package org.springframework.test.context;
* {@code TestExecutionListener} defines a <em>listener</em> API for reacting to * {@code TestExecutionListener} defines a <em>listener</em> API for reacting to
* test execution events published by the {@link TestContextManager} with which * test execution events published by the {@link TestContextManager} with which
* the listener is registered. * the listener is registered.
* <p> * <p>Concrete implementations must provide a {@code public} no-args constructor,
* Concrete implementations must provide a {@code public} no-args constructor,
* so that listeners can be instantiated transparently by tools and configuration * so that listeners can be instantiated transparently by tools and configuration
* mechanisms. * mechanisms.
* <p> * <p>Spring provides the following out-of-the-box implementations:
* Spring provides the following out-of-the-box implementations:
* <ul> * <ul>
* <li>{@link org.springframework.test.context.web.ServletTestExecutionListener
* ServletTestExecutionListener}</li>
* <li>{@link org.springframework.test.context.support.DependencyInjectionTestExecutionListener * <li>{@link org.springframework.test.context.support.DependencyInjectionTestExecutionListener
* DependencyInjectionTestExecutionListener}</li> * DependencyInjectionTestExecutionListener}</li>
* <li>{@link org.springframework.test.context.support.DirtiesContextTestExecutionListener * <li>{@link org.springframework.test.context.support.DirtiesContextTestExecutionListener
* DirtiesContextTestExecutionListener}</li> * DirtiesContextTestExecutionListener}</li>
* <li>{@link org.springframework.test.context.transaction.TransactionalTestExecutionListener * <li>{@link org.springframework.test.context.transaction.TransactionalTestExecutionListener
* TransactionalTestExecutionListener}</li> * TransactionalTestExecutionListener}</li>
* <li>{@link org.springframework.test.context.web.ServletTestExecutionListener * <li>{@link org.springframework.test.context.jdbc.SqlScriptsTestExecutionListener
* ServletTestExecutionListener}</li> * SqlScriptsTestExecutionListener}</li>
* </ul> * </ul>
* *
* @author Sam Brannen * @author Sam Brannen
@ -46,13 +46,10 @@ public interface TestExecutionListener {
/** /**
* Pre-processes a test class <em>before</em> execution of all tests within * Pre-processes a test class <em>before</em> execution of all tests within
* the class. * the class.
* <p> * <p>This method should be called immediately before framework-specific
* This method should be called immediately before framework-specific
* <em>before class</em> lifecycle callbacks. * <em>before class</em> lifecycle callbacks.
* <p> * <p>If a given testing framework does not support <em>before class</em>
* If a given testing framework (e.g., JUnit 3.8) does not support * lifecycle callbacks, this method will not be called for that framework.
* <em>before class</em> lifecycle callbacks, this method will not be called
* for that framework.
* *
* @param testContext the test context for the test; never {@code null} * @param testContext the test context for the test; never {@code null}
* @throws Exception allows any exception to propagate * @throws Exception allows any exception to propagate
@ -62,8 +59,7 @@ public interface TestExecutionListener {
/** /**
* Prepares the {@link Object test instance} of the supplied * Prepares the {@link Object test instance} of the supplied
* {@link TestContext test context}, for example by injecting dependencies. * {@link TestContext test context}, for example by injecting dependencies.
* <p> * <p>This method should be called immediately after instantiation of the test
* This method should be called immediately after instantiation of the test
* instance but prior to any framework-specific lifecycle callbacks. * instance but prior to any framework-specific lifecycle callbacks.
* *
* @param testContext the test context for the test; never {@code null} * @param testContext the test context for the test; never {@code null}
@ -76,8 +72,7 @@ public interface TestExecutionListener {
* {@link java.lang.reflect.Method test method} in the supplied * {@link java.lang.reflect.Method test method} in the supplied
* {@link TestContext test context}, for example by setting up test * {@link TestContext test context}, for example by setting up test
* fixtures. * fixtures.
* <p> * <p>This method should be called immediately prior to framework-specific
* This method should be called immediately prior to framework-specific
* <em>before</em> lifecycle callbacks. * <em>before</em> lifecycle callbacks.
* *
* @param testContext the test context in which the test method will be * @param testContext the test context in which the test method will be
@ -91,8 +86,7 @@ public interface TestExecutionListener {
* {@link java.lang.reflect.Method test method} in the supplied * {@link java.lang.reflect.Method test method} in the supplied
* {@link TestContext test context}, for example by tearing down test * {@link TestContext test context}, for example by tearing down test
* fixtures. * fixtures.
* <p> * <p>This method should be called immediately after framework-specific
* This method should be called immediately after framework-specific
* <em>after</em> lifecycle callbacks. * <em>after</em> lifecycle callbacks.
* *
* @param testContext the test context in which the test method was * @param testContext the test context in which the test method was
@ -104,13 +98,10 @@ public interface TestExecutionListener {
/** /**
* Post-processes a test class <em>after</em> execution of all tests within * Post-processes a test class <em>after</em> execution of all tests within
* the class. * the class.
* <p> * <p>This method should be called immediately after framework-specific
* This method should be called immediately after framework-specific
* <em>after class</em> lifecycle callbacks. * <em>after class</em> lifecycle callbacks.
* <p> * <p>If a given testing framework does not support <em>after class</em>
* If a given testing framework (e.g., JUnit 3.8) does not support * lifecycle callbacks, this method will not be called for that framework.
* <em>after class</em> lifecycle callbacks, this method will not be called
* for that framework.
* *
* @param testContext the test context for the test; never {@code null} * @param testContext the test context for the test; never {@code null}
* @throws Exception allows any exception to propagate * @throws Exception allows any exception to propagate

Loading…
Cancel
Save