Class DirtiesContexttestExecutionListener

java.lang.Object

org.springframework.test.context.support.AbstracttestExecutionListener

org.springframework.test.context.support.AbstractDirtiesContexttestExecutionListener

org.springframework.test.context.support.DirtiesContexttestExecutionListener

All Implemented Interfaces:

Ordered, testExecutionListener

public class DirtiesContexttestExecutionListener
extends AbstractDirtiesContexttestExecutionListener

testExecutionListener which provides support for marking the ApplicationContext associated with a test as dirty for both test classes and test methods annotated with the @DirtiesContext annotation.

This listener supports test methods with the method mode set to AFTER_METHOD and test classes with the class mode set to AFTER_EACH_test_METHOD or AFTER_CLASS. For support for BEFORE modes, see DirtiesContextBeforeModestestExecutionListener.

When merging testExecutionListeners with the defaults, this listener will automatically be ordered after the DependencyInjectiontestExecutionListener; otherwise, this listener must be manually configured to execute after the DependencyInjectiontestExecutionListener.

Since:

2.5

Author:

Sam Brannen

See Also:

• DirtiesContext
• DirtiesContextBeforeModestestExecutionListener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORDER	The order value for this listener: 3000.

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DirtiesContexttestExecutionListener()

Method Summary

Modifier and Type	Method	Description
void	aftertestClass(testContext testContext)	If the test class of the supplied test context is annotated with @DirtiesContext and the class mode is set to AFTER_CLASS, the application context of the test context will be marked as dirty, and the REINJECT_DEPENDENCIES_ATTRIBUTE in the test context will be set to true.
void	aftertestMethod(testContext testContext)	If the current test method of the supplied test context is annotated with @DirtiesContext and the method mode is set to AFTER_METHOD, or if the test class is annotated with @DirtiesContext and the class mode is set to AFTER_EACH_test_METHOD, the application context of the test context will be marked as dirty and the REINJECT_DEPENDENCIES_ATTRIBUTE in the test context will be set to true.
final int	getOrder()	Returns 3000, which ensures that the DirtiesContexttestExecutionListener is ordered after the DependencyInjectiontestExecutionListener and before the CommonCachestestExecutionListener.

Methods inherited from class AbstractDirtiesContexttestExecutionListener

beforeOrAftertestClass, beforeOrAftertestMethod, dirtyContext

Methods inherited from class AbstracttestExecutionListener

aftertestExecution, beforetestClass, beforetestExecution, beforetestMethod, preparetestInstance

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ORDER

public static final int ORDER

The order value for this listener: 3000.

Since:

6.2.3

See Also:

• Constant Field Values

Constructor Details

DirtiesContexttestExecutionListener

public DirtiesContexttestExecutionListener()

Method Details

getOrder

public final int getOrder()

Returns 3000, which ensures that the DirtiesContexttestExecutionListener is ordered after the DependencyInjectiontestExecutionListener and before the CommonCachestestExecutionListener.

Specified by:

getOrder in interface Ordered

Specified by:

getOrder in class AbstractDirtiesContexttestExecutionListener

Returns:

the order value

See Also:

• Ordered.HIGHEST_PRECEDENCE
• Ordered.LOWEST_PRECEDENCE

aftertestMethod

public void aftertestMethod(testContext testContext)
                     throws Exception

If the current test method of the supplied test context is annotated with @DirtiesContext and the method mode is set to AFTER_METHOD, or if the test class is annotated with @DirtiesContext and the class mode is set to AFTER_EACH_test_METHOD, the application context of the test context will be marked as dirty and the REINJECT_DEPENDENCIES_ATTRIBUTE in the test context will be set to true.

Specified by:

aftertestMethod in interface testExecutionListener

Overrides:

aftertestMethod in class AbstracttestExecutionListener

Parameters:

testContext - the test context in which the test method was executed; never null

Throws:

Exception - allows any exception to propagate

See Also:

• testExecutionListener.beforetestMethod(testContext)
• testExecutionListener.beforetestExecution(testContext)
• testExecutionListener.aftertestExecution(testContext)

aftertestClass

public void aftertestClass(testContext testContext)
                    throws Exception

If the test class of the supplied test context is annotated with @DirtiesContext and the class mode is set to AFTER_CLASS, the application context of the test context will be marked as dirty, and the REINJECT_DEPENDENCIES_ATTRIBUTE in the test context will be set to true.

Specified by:

aftertestClass in interface testExecutionListener

Overrides:

aftertestClass in class AbstracttestExecutionListener

Parameters:

testContext - the test context for the test; never null

Throws:

Exception - allows any exception to propagate