org.springframework.test.context

Class MergedContextConfiguration

java.lang.Object

org.springframework.test.context.MergedContextConfiguration

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WebMergedContextConfiguration

public class MergedContextConfiguration
extends Object
implements Serializable

MergedContextConfiguration encapsulates the merged context configuration declared on a test class and all of its superclasses and enclosing classes via @ContextConfiguration, @ActiveProfiles, and @TestPropertySource.

Merged context resource locations, annotated classes, active profiles, property resource locations, and in-lined properties represent all declared values in the test class hierarchy and enclosing class hierarchy taking into consideration the semantics of the ContextConfiguration.inheritLocations(), ActiveProfiles.inheritProfiles(), TestPropertySource.inheritLocations(), and TestPropertySource.inheritProperties() flags.

A SmartContextLoader uses MergedContextConfiguration to load an ApplicationContext.

MergedContextConfiguration is also used by the ContextCache as the key for caching an ApplicationContext that was loaded using properties of this MergedContextConfiguration.

Since:

3.1

Author:

Sam Brannen, Phillip Webb

See Also:

ContextConfiguration, ContextHierarchy, ActiveProfiles, TestPropertySource, ContextConfigurationAttributes, SmartContextLoader.loadContext(MergedContextConfiguration), Serialized Form

Constructor Summary

Constructors

Constructor and Description
MergedContextConfiguration(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader) Create a new MergedContextConfiguration instance for the supplied parameters.
MergedContextConfiguration(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a new MergedContextConfiguration instance for the supplied parameters.
MergedContextConfiguration(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a new MergedContextConfiguration instance for the supplied parameters.
MergedContextConfiguration(Class<?> testClass, String[] locations, Class<?>[] classes, Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String[] activeProfiles, String[] propertySourceLocations, String[] propertySourceProperties, Set<ContextCustomizer> contextCustomizers, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, MergedContextConfiguration parent) Create a new MergedContextConfiguration instance for the supplied parameters.
MergedContextConfiguration(Class<?> testClass, String[] locations, Class<?>[] classes, String[] activeProfiles, ContextLoader contextLoader) Create a new MergedContextConfiguration instance for the supplied parameters.
MergedContextConfiguration(MergedContextConfiguration mergedConfig) Create a new MergedContextConfiguration instance by copying all fields from the supplied MergedContextConfiguration.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Determine if the supplied object is equal to this MergedContextConfiguration instance by comparing both object's locations, annotated classes, context initializer classes, active profiles, property source locations, property source properties, parents, and the fully qualified names of their ContextLoaders.
String[]	getActiveProfiles() Get the merged active bean definition profiles for the test class.
Class<?>[]	getClasses() Get the merged annotated classes for the test class.
Set<ContextCustomizer>	getContextCustomizers() Get the merged ContextCustomizers that will be applied when the application context is loaded.
Set<Class<? extends ApplicationContextInitializer<?>>>	getContextInitializerClasses() Get the merged ApplicationContextInitializer classes for the test class.
ContextLoader	getContextLoader() Get the resolved ContextLoader for the test class.
String[]	getLocations() Get the merged resource locations for ApplicationContext configuration files for the test class.
MergedContextConfiguration	getParent() Get the MergedContextConfiguration for the parent application context in a context hierarchy.
ApplicationContext	getParentApplicationContext() Get the parent ApplicationContext for the context defined by this MergedContextConfiguration from the context cache.
String[]	getPropertySourceLocations() Get the merged resource locations for test PropertySources for the test class.
String[]	getPropertySourceProperties() Get the merged test PropertySource properties for the test class.
Class<?>	getTestClass() Get the test class associated with this MergedContextConfiguration.
boolean	hasClasses() Determine if this MergedContextConfiguration instance has class-based resources.
int	hashCode() Generate a unique hash code for all properties of this MergedContextConfiguration excluding the test class.
boolean	hasLocations() Determine if this MergedContextConfiguration instance has path-based context resource locations.
boolean	hasResources() Determine if this MergedContextConfiguration instance has either path-based context resource locations or class-based resources.
protected static String	nullSafeClassName(ContextLoader contextLoader) Generate a null-safe String representation of the supplied ContextLoader based solely on the fully qualified name of the loader or "null" if the supplied loader is null.
String	toString() Provide a String representation of the test class, locations, annotated classes, context initializer classes, active profiles, property source locations, property source properties, context customizers, the name of the ContextLoader, and the parent configuration.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MergedContextConfiguration

public MergedContextConfiguration(Class<?> testClass,
                                  @Nullable
                                  String[] locations,
                                  @Nullable
                                  Class<?>[] classes,
                                  @Nullable
                                  String[] activeProfiles,
                                  @Nullable
                                  ContextLoader contextLoader)

Create a new MergedContextConfiguration instance for the supplied parameters.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

activeProfiles - the merged active bean definition profiles

contextLoader - the resolved ContextLoader

MergedContextConfiguration

public MergedContextConfiguration(Class<?> testClass,
                                  @Nullable
                                  String[] locations,
                                  @Nullable
                                  Class<?>[] classes,
                                  @Nullable
                                  Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
                                  @Nullable
                                  String[] activeProfiles,
                                  @Nullable
                                  ContextLoader contextLoader)

Create a new MergedContextConfiguration instance for the supplied parameters.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

contextLoader - the resolved ContextLoader

MergedContextConfiguration

public MergedContextConfiguration(Class<?> testClass,
                                  @Nullable
                                  String[] locations,
                                  @Nullable
                                  Class<?>[] classes,
                                  @Nullable
                                  Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
                                  @Nullable
                                  String[] activeProfiles,
                                  @Nullable
                                  ContextLoader contextLoader,
                                  @Nullable
                                  CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
                                  @Nullable
                                  MergedContextConfiguration parent)

Create a new MergedContextConfiguration instance for the supplied parameters.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

contextLoader - the resolved ContextLoader

cacheAwareContextLoaderDelegate - a cache-aware context loader delegate with which to retrieve the parent context

parent - the parent configuration or null if there is no parent

Since:

3.2.2

MergedContextConfiguration

public MergedContextConfiguration(MergedContextConfiguration mergedConfig)

Create a new MergedContextConfiguration instance by copying all fields from the supplied MergedContextConfiguration.

Since:

4.1

MergedContextConfiguration

public MergedContextConfiguration(Class<?> testClass,
                                  @Nullable
                                  String[] locations,
                                  @Nullable
                                  Class<?>[] classes,
                                  @Nullable
                                  Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
                                  @Nullable
                                  String[] activeProfiles,
                                  @Nullable
                                  String[] propertySourceLocations,
                                  @Nullable
                                  String[] propertySourceProperties,
                                  @Nullable
                                  ContextLoader contextLoader,
                                  @Nullable
                                  CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
                                  @Nullable
                                  MergedContextConfiguration parent)

Create a new MergedContextConfiguration instance for the supplied parameters.

If a null value is supplied for locations, classes, activeProfiles, propertySourceLocations, or propertySourceProperties an empty array will be stored instead. If a null value is supplied for the contextInitializerClasses an empty set will be stored instead. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

propertySourceLocations - the merged PropertySource locations

propertySourceProperties - the merged PropertySource properties

contextLoader - the resolved ContextLoader

cacheAwareContextLoaderDelegate - a cache-aware context loader delegate with which to retrieve the parent context

parent - the parent configuration or null if there is no parent

Since:

4.1

MergedContextConfiguration

public MergedContextConfiguration(Class<?> testClass,
                                  @Nullable
                                  String[] locations,
                                  @Nullable
                                  Class<?>[] classes,
                                  @Nullable
                                  Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
                                  @Nullable
                                  String[] activeProfiles,
                                  @Nullable
                                  String[] propertySourceLocations,
                                  @Nullable
                                  String[] propertySourceProperties,
                                  @Nullable
                                  Set<ContextCustomizer> contextCustomizers,
                                  @Nullable
                                  ContextLoader contextLoader,
                                  @Nullable
                                  CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
                                  @Nullable
                                  MergedContextConfiguration parent)

Create a new MergedContextConfiguration instance for the supplied parameters.

If a null value is supplied for locations, classes, activeProfiles, propertySourceLocations, or propertySourceProperties an empty array will be stored instead. If a null value is supplied for contextInitializerClasses or contextCustomizers, an empty set will be stored instead. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

propertySourceLocations - the merged PropertySource locations

propertySourceProperties - the merged PropertySource properties

contextCustomizers - the context customizers

contextLoader - the resolved ContextLoader

cacheAwareContextLoaderDelegate - a cache-aware context loader delegate with which to retrieve the parent context

parent - the parent configuration or null if there is no parent

Since:

4.3

Method Detail

getTestClass

public Class<?> getTestClass()

Get the test class associated with this MergedContextConfiguration.

getLocations

public String[] getLocations()

Get the merged resource locations for ApplicationContext configuration files for the test class.

Context resource locations typically represent XML configuration files or Groovy scripts.

getClasses

public Class<?>[] getClasses()

Get the merged annotated classes for the test class.

hasLocations

public boolean hasLocations()

Determine if this MergedContextConfiguration instance has path-based context resource locations.

Returns:

true if the locations array is not empty

Since:

4.0.4

See Also:

hasResources(), hasClasses()

hasClasses

public boolean hasClasses()

Determine if this MergedContextConfiguration instance has class-based resources.

Returns:

true if the classes array is not empty

Since:

4.0.4

See Also:

hasResources(), hasLocations()

hasResources

public boolean hasResources()

Determine if this MergedContextConfiguration instance has either path-based context resource locations or class-based resources.

Returns:

true if either the locations or the classes array is not empty

Since:

4.0.4

See Also:

hasLocations(), hasClasses()

getContextInitializerClasses

public Set<Class<? extends ApplicationContextInitializer<?>>> getContextInitializerClasses()

Get the merged ApplicationContextInitializer classes for the test class.

getActiveProfiles

public String[] getActiveProfiles()

Get the merged active bean definition profiles for the test class.

See Also:

ActiveProfiles

getPropertySourceLocations

public String[] getPropertySourceLocations()

Get the merged resource locations for test PropertySources for the test class.

See Also:

TestPropertySource.locations(), Properties

getPropertySourceProperties

public String[] getPropertySourceProperties()

Get the merged test PropertySource properties for the test class.

Properties will be loaded into the Environment's set of PropertySources.

See Also:

TestPropertySource.properties(), Properties

getContextCustomizers

public Set<ContextCustomizer> getContextCustomizers()

Get the merged ContextCustomizers that will be applied when the application context is loaded.

getContextLoader

public ContextLoader getContextLoader()

Get the resolved ContextLoader for the test class.

getParent

@Nullable
public MergedContextConfiguration getParent()

Get the MergedContextConfiguration for the parent application context in a context hierarchy.

Returns:

the parent configuration or null if there is no parent

Since:

3.2.2

See Also:

getParentApplicationContext()

getParentApplicationContext

@Nullable
public ApplicationContext getParentApplicationContext()

Get the parent ApplicationContext for the context defined by this MergedContextConfiguration from the context cache.

If the parent context has not yet been loaded, it will be loaded, stored in the cache, and then returned.

Returns:

the parent ApplicationContext or null if there is no parent

Since:

3.2.2

See Also:

getParent()

equals

public boolean equals(@Nullable
                      Object other)

Determine if the supplied object is equal to this MergedContextConfiguration instance by comparing both object's locations, annotated classes, context initializer classes, active profiles, property source locations, property source properties, parents, and the fully qualified names of their ContextLoaders.

Overrides:

equals in class Object

hashCode

public int hashCode()

Generate a unique hash code for all properties of this MergedContextConfiguration excluding the test class.

Overrides:

hashCode in class Object

toString

public String toString()

Provide a String representation of the test class, locations, annotated classes, context initializer classes, active profiles, property source locations, property source properties, context customizers, the name of the ContextLoader, and the parent configuration.

Overrides:

toString in class Object

nullSafeClassName

protected static String nullSafeClassName(@Nullable
                                          ContextLoader contextLoader)

Generate a null-safe String representation of the supplied ContextLoader based solely on the fully qualified name of the loader or "null" if the supplied loader is null.