Class DefaultTestContext

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:

  NullPointerException - if the supplied DefaultTestContext is null

• DefaultTestContext

  public DefaultTestContext​(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

• hasApplicationContext

  public boolean hasApplicationContext()

  Determine if the application context for this test context is present in the context cache.

  Specified by:

  hasApplicationContext in interface TestContext

  Returns:

  true if the application context has already been loaded and stored in the context cache

  Since:

  5.2

  See Also:

  getApplicationContext(), CacheAwareContextLoaderDelegate.isContextLoaded(org.springframework.test.context.MergedContextConfiguration)

• 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:

  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 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 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 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 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
                          Object testInstance,
                          @Nullable
                          Method testMethod,
                          @Nullable
                          Throwable testException)

  Description copied from interface: TestContext
  Update this test context to reflect the state of the currently executing test.

  WARNING: This method should only be invoked by the TestContextManager.

  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​(String name,
                           @Nullable
                           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 Object getAttribute​(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 Object removeAttribute​(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​(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 String[] attributeNames()

  Description copied from interface: AttributeAccessor
  Return the names of all attributes.

  Specified by:

  attributeNames in interface AttributeAccessor

• toString

  public String toString()

  Provide a String representation of this test context's state.

  Overrides:

  toString in class Object