DefaultTestContext

java.lang.Object
- org.springframework.test.context.support.DefaultTestContext

All Implemented Interfaces:

java.io.Serializable, AttributeAccessor, TestContext
```
public class DefaultTestContext
extends java.lang.Object
implements TestContext
```
Default implementation of the TestContext interface.

Since:

4.0

Author:

Sam Brannen, Juergen Hoeller, Rob Harrop

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.String,java.lang.Object>`	`attributes`
`private CacheAwareContextLoaderDelegate`	`cacheAwareContextLoaderDelegate`
`private MergedContextConfiguration`	`mergedContextConfiguration`
`private static long`	`serialVersionUID`
`private java.lang.Class<?>`	`testClass`
`private java.lang.Throwable`	`testException`
`private java.lang.Object`	`testInstance`
`private java.lang.reflect.Method`	`testMethod`

Constructor Summary

Constructors
Constructor and Description
`DefaultTestContext(java.lang.Class<?> testClass, MergedContextConfiguration mergedContextConfiguration, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate)` Construct a new `DefaultTestContext` from the supplied arguments.
`DefaultTestContext(DefaultTestContext testContext)` Copy constructor for creating a new `DefaultTestContext` based on the attributes and immutable state of the supplied context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`attributeNames()` Return the names of all attributes.
`ApplicationContext`	`getApplicationContext()` Get the application context for this test context.
`java.lang.Object`	`getAttribute(java.lang.String name)` Get the value of the attribute identified by `name`.
`java.lang.Class<?>`	`getTestClass()` Get the test class for this test context.
`java.lang.Throwable`	`getTestException()` Get the exception that was thrown during execution of the test method.
`java.lang.Object`	`getTestInstance()` Get the current test instance for this test context.
`java.lang.reflect.Method`	`getTestMethod()` Get the current test method for this test context.
`boolean`	`hasAttribute(java.lang.String name)` Return `true` if the attribute identified by `name` exists.
`void`	`markApplicationContextDirty(DirtiesContext.HierarchyMode hierarchyMode)` Mark the application context associated with this test context as dirty (i.e., by removing it from the context cache and closing it).
`java.lang.Object`	`removeAttribute(java.lang.String name)` Remove the attribute identified by `name` and return its value.
`void`	`setAttribute(java.lang.String name, java.lang.Object value)` Set the attribute defined by `name` to the supplied `value`.
`java.lang.String`	`toString()` Provide a String representation of this test context's state.
`void`	`updateState(java.lang.Object testInstance, java.lang.reflect.Method testMethod, java.lang.Throwable testException)` Update this test context to reflect the state of the currently executing test.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - attributes
```
private final java.util.Map<java.lang.String,java.lang.Object> attributes
```
  - cacheAwareContextLoaderDelegate
```
private final CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate
```
  - mergedContextConfiguration
```
private final MergedContextConfiguration mergedContextConfiguration
```
  - testClass
```
private final java.lang.Class<?> testClass
```
  - testInstance
```
@Nullable
private volatile java.lang.Object testInstance
```
  - testMethod
```
@Nullable
private volatile java.lang.reflect.Method testMethod
```
  - testException
```
@Nullable
private volatile java.lang.Throwable testException
```
- Constructor Detail
  - DefaultTestContext
```
public DefaultTestContext(DefaultTestContext testContext)
```
    Copy constructor for creating a new DefaultTestContext based on the attributes and immutable state of the supplied context.
    Immutable state includes all arguments supplied to the standard constructor.
    
    Throws:
    
    java.lang.NullPointerException - if the supplied DefaultTestContext is null
  - DefaultTestContext
```
public DefaultTestContext(java.lang.Class<?> testClass,
                          MergedContextConfiguration mergedContextConfiguration,
                          CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate)
```
    Construct a new DefaultTestContext from the supplied arguments.
    
    Parameters:
    
    testClass - the test class for this test context
    
    mergedContextConfiguration - the merged application context configuration for this test context
    
    cacheAwareContextLoaderDelegate - the delegate to use for loading and closing the application context for this test context
- Method Detail
  - getApplicationContext
```
public ApplicationContext getApplicationContext()
```
    Get the application context for this test context.
    The default implementation delegates to the CacheAwareContextLoaderDelegate that was supplied when this TestContext was constructed.
    
    Specified by:
    
    getApplicationContext in interface TestContext
    
    Returns:
    
    the application context (never null)
    
    Throws:
    
    java.lang.IllegalStateException - if the context returned by the context loader delegate is not active (i.e., has been closed).
    
    See Also:
    
    CacheAwareContextLoaderDelegate.loadContext(org.springframework.test.context.MergedContextConfiguration)
  - markApplicationContextDirty
```
public void markApplicationContextDirty(@Nullable
                                        DirtiesContext.HierarchyMode hierarchyMode)
```
    Mark the application context associated with this test context as dirty (i.e., by removing it from the context cache and closing it).
    The default implementation delegates to the CacheAwareContextLoaderDelegate that was supplied when this TestContext was constructed.
    
    Specified by:
    
    markApplicationContextDirty in interface TestContext
    
    Parameters:
    
    hierarchyMode - the context cache clearing mode to be applied if the context is part of a hierarchy (may be null)
    
    See Also:
    
    CacheAwareContextLoaderDelegate.closeContext(org.springframework.test.context.MergedContextConfiguration, org.springframework.test.annotation.DirtiesContext.HierarchyMode)
  - getTestClass
```
public final java.lang.Class<?> getTestClass()
```
    Description copied from interface: TestContext
    
    Get the test class for this test context.
    
    Specified by:
    
    getTestClass in interface TestContext
    
    Returns:
    
    the test class (never null)
  - getTestInstance
```
public final java.lang.Object getTestInstance()
```
    Description copied from interface: TestContext
    
    Get the current test instance for this test context.
    Note: this is a mutable property.
    
    Specified by:
    
    getTestInstance in interface TestContext
    
    Returns:
    
    the current test instance (never null)
    
    See Also:
    
    TestContext.updateState(Object, Method, Throwable)
  - getTestMethod
```
public final java.lang.reflect.Method getTestMethod()
```
    Description copied from interface: TestContext
    
    Get the current test method for this test context.
    Note: this is a mutable property.
    
    Specified by:
    
    getTestMethod in interface TestContext
    
    Returns:
    
    the current test method (never null)
    
    See Also:
    
    TestContext.updateState(Object, Method, Throwable)
  - getTestException
```
@Nullable
public final java.lang.Throwable getTestException()
```
    Description copied from interface: TestContext
    
    Get the exception that was thrown during execution of the test method.
    Note: this is a mutable property.
    
    Specified by:
    
    getTestException in interface TestContext
    
    Returns:
    
    the exception that was thrown, or null if no exception was thrown
    
    See Also:
    
    TestContext.updateState(Object, Method, Throwable)
  - updateState
```
public void updateState(@Nullable
                        java.lang.Object testInstance,
                        @Nullable
                        java.lang.reflect.Method testMethod,
                        @Nullable
                        java.lang.Throwable testException)
```
    Description copied from interface: TestContext
    
    Update this test context to reflect the state of the currently executing test.
    Caution: concurrent invocations of this method might not be thread-safe, depending on the underlying implementation.
    
    Specified by:
    
    updateState in interface TestContext
    
    Parameters:
    
    testInstance - the current test instance (may be null)
    
    testMethod - the current test method (may be null)
    
    testException - the exception that was thrown in the test method, or null if no exception was thrown
  - setAttribute
```
public void setAttribute(java.lang.String name,
                         @Nullable
                         java.lang.Object value)
```
    Description copied from interface: AttributeAccessor
    
    Set the attribute defined by name to the supplied value. If value is null, the attribute is removed.
    In general, users should take care to prevent overlaps with other metadata attributes by using fully-qualified names, perhaps using class or package names as prefix.
    
    Specified by:
    
    setAttribute in interface AttributeAccessor
    
    Parameters:
    
    name - the unique attribute key
    
    value - the attribute value to be attached
  - getAttribute
```
@Nullable
public java.lang.Object getAttribute(java.lang.String name)
```
    Description copied from interface: AttributeAccessor
    
    Get the value of the attribute identified by name. Return null if the attribute doesn't exist.
    
    Specified by:
    
    getAttribute in interface AttributeAccessor
    
    Parameters:
    
    name - the unique attribute key
    
    Returns:
    
    the current value of the attribute, if any
  - removeAttribute
```
@Nullable
public java.lang.Object removeAttribute(java.lang.String name)
```
    Description copied from interface: AttributeAccessor
    
    Remove the attribute identified by name and return its value. Return null if no attribute under name is found.
    
    Specified by:
    
    removeAttribute in interface AttributeAccessor
    
    Parameters:
    
    name - the unique attribute key
    
    Returns:
    
    the last value of the attribute, if any
  - hasAttribute
```
public boolean hasAttribute(java.lang.String name)
```
    Description copied from interface: AttributeAccessor
    
    Return true if the attribute identified by name exists. Otherwise return false.
    
    Specified by:
    
    hasAttribute in interface AttributeAccessor
    
    Parameters:
    
    name - the unique attribute key
  - attributeNames
```
public java.lang.String[] attributeNames()
```
    Description copied from interface: AttributeAccessor
    
    Return the names of all attributes.
    
    Specified by:
    
    attributeNames in interface AttributeAccessor
  - toString
```
public java.lang.String toString()
```
    Provide a String representation of this test context's state.
    
    Overrides:
    
    toString in class java.lang.Object

Class DefaultTestContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

attributes

cacheAwareContextLoaderDelegate

mergedContextConfiguration

testClass

testInstance

testMethod

testException

Constructor Detail

DefaultTestContext

DefaultTestContext

Method Detail

getApplicationContext

markApplicationContextDirty

getTestClass

getTestInstance

getTestMethod

getTestException

updateState

setAttribute

getAttribute

removeAttribute

hasAttribute

attributeNames

toString