Package org.springframework.test.context.support

Class AbstractDirtiesContextTestExecutionListener

java.lang.Object

org.springframework.test.context.support.AbstractTestExecutionListener

org.springframework.test.context.support.AbstractDirtiesContextTestExecutionListener

All Implemented Interfaces:

Ordered, TestExecutionListener

Direct Known Subclasses:

DirtiesContextBeforeModesTestExecutionListener, DirtiesContextTestExecutionListener

public abstract class AbstractDirtiesContextTestExecutionListener
extends AbstractTestExecutionListener

Abstract base class for TestExecutionListener implementations that provide support for marking the ApplicationContext associated with a test as dirty for both test classes and test methods annotated with the @DirtiesContext annotation.

The core functionality for this class was extracted from DirtiesContextTestExecutionListener in Spring Framework 4.2.

Since:

4.2

Author:

Sam Brannen, Juergen Hoeller

See Also:

• DirtiesContext

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AbstractDirtiesContextTestExecutionListener()

Method Summary

Modifier and Type	Method	Description
protected void	beforeOrAfterTestClass(TestContext testContext, DirtiesContext.ClassMode requiredClassMode)	Perform the actual work for AbstractTestExecutionListener.beforeTestClass(org.springframework.test.context.TestContext) and AbstractTestExecutionListener.afterTestClass(org.springframework.test.context.TestContext) by dirtying the context if appropriate (i.e., according to the required mode).
protected void	beforeOrAfterTestMethod(TestContext testContext, DirtiesContext.MethodMode requiredMethodMode, DirtiesContext.ClassMode requiredClassMode)	Perform the actual work for AbstractTestExecutionListener.beforeTestMethod(org.springframework.test.context.TestContext) and AbstractTestExecutionListener.afterTestMethod(org.springframework.test.context.TestContext) by dirtying the context if appropriate (i.e., according to the required modes).
protected void	dirtyContext(TestContext testContext, DirtiesContext.HierarchyMode hierarchyMode)	Mark the application context of the supplied test context as dirty and set REINJECT_DEPENDENCIES_ATTRIBUTE in the test context to true.
abstract int	getOrder()	The default implementation returns Ordered.LOWEST_PRECEDENCE, thereby ensuring that custom listeners are ordered after default listeners supplied by the framework.

Methods inherited from class org.springframework.test.context.support.AbstractTestExecutionListener

afterTestClass, afterTestExecution, afterTestMethod, beforeTestClass, beforeTestExecution, beforeTestMethod, prepareTestInstance

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDirtiesContextTestExecutionListener

public AbstractDirtiesContextTestExecutionListener()

Method Details

getOrder

public abstract int getOrder()

Description copied from class: AbstractTestExecutionListener

The default implementation returns Ordered.LOWEST_PRECEDENCE, thereby ensuring that custom listeners are ordered after default listeners supplied by the framework. Can be overridden by subclasses as necessary.

Specified by:

getOrder in interface Ordered

Overrides:

getOrder in class AbstractTestExecutionListener

Returns:

the order value

See Also:

• Ordered.HIGHEST_PRECEDENCE
• Ordered.LOWEST_PRECEDENCE

dirtyContext

protected void dirtyContext(TestContext testContext,
 @Nullable
 DirtiesContext.HierarchyMode hierarchyMode)

Mark the application context of the supplied test context as dirty and set REINJECT_DEPENDENCIES_ATTRIBUTE in the test context to true.

Parameters:

testContext - the test context whose application context should be marked as dirty

hierarchyMode - the context cache clearing mode to be applied if the context is part of a hierarchy; may be null

Since:

3.2.2

beforeOrAfterTestMethod

protected void beforeOrAfterTestMethod(TestContext testContext,
 DirtiesContext.MethodMode requiredMethodMode,
 DirtiesContext.ClassMode requiredClassMode)
                                throws Exception

Perform the actual work for AbstractTestExecutionListener.beforeTestMethod(org.springframework.test.context.TestContext) and AbstractTestExecutionListener.afterTestMethod(org.springframework.test.context.TestContext) by dirtying the context if appropriate (i.e., according to the required modes).

Parameters:

testContext - the test context whose application context should potentially be marked as dirty; never null

requiredMethodMode - the method mode required for a context to be marked dirty in the current phase; never null

requiredClassMode - the class mode required for a context to be marked dirty in the current phase; never null

Throws:

Exception - allows any exception to propagate

Since:

4.2

See Also:

• dirtyContext(org.springframework.test.context.TestContext, org.springframework.test.annotation.DirtiesContext.HierarchyMode)

beforeOrAfterTestClass

protected void beforeOrAfterTestClass(TestContext testContext,
 DirtiesContext.ClassMode requiredClassMode)
                               throws Exception

Perform the actual work for AbstractTestExecutionListener.beforeTestClass(org.springframework.test.context.TestContext) and AbstractTestExecutionListener.afterTestClass(org.springframework.test.context.TestContext) by dirtying the context if appropriate (i.e., according to the required mode).

Parameters:

testContext - the test context whose application context should potentially be marked as dirty; never null

requiredClassMode - the class mode required for a context to be marked dirty in the current phase; never null

Throws:

Exception - allows any exception to propagate

Since:

4.2

See Also:

• dirtyContext(org.springframework.test.context.TestContext, org.springframework.test.annotation.DirtiesContext.HierarchyMode)