org.springframework.test.context

Class ContextConfigurationAttributes

java.lang.Object

org.springframework.test.context.ContextConfigurationAttributes

public class ContextConfigurationAttributes
extends java.lang.Object

ContextConfigurationAttributes encapsulates the context configuration attributes declared on a test class via @ContextConfiguration.

Since:

3.1

Author:

Sam Brannen

See Also:

ContextConfiguration, SmartContextLoader.processContextConfiguration(ContextConfigurationAttributes), MergedContextConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<?>[]	classes
private java.lang.Class<? extends ContextLoader>	contextLoaderClass
private java.lang.Class<?>	declaringClass
private boolean	inheritInitializers
private boolean	inheritLocations
private java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[]	initializers
private java.lang.String[]	locations
private static Log	logger
private java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
ContextConfigurationAttributes(java.lang.Class<?> declaringClass, ContextConfiguration contextConfiguration) Construct a new ContextConfigurationAttributes instance for the supplied @ContextConfiguration annotation and the test class that declared it.
ContextConfigurationAttributes(java.lang.Class<?> declaringClass, java.lang.String[] locations, java.lang.Class<?>[] classes, boolean inheritLocations, java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] initializers, boolean inheritInitializers, java.lang.Class<? extends ContextLoader> contextLoaderClass) Construct a new ContextConfigurationAttributes instance for the test class that declared the @ContextConfiguration annotation and its corresponding attributes.
ContextConfigurationAttributes(java.lang.Class<?> declaringClass, java.lang.String[] locations, java.lang.Class<?>[] classes, boolean inheritLocations, java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] initializers, boolean inheritInitializers, java.lang.String name, java.lang.Class<? extends ContextLoader> contextLoaderClass) Construct a new ContextConfigurationAttributes instance for the test class that declared the @ContextConfiguration annotation and its corresponding attributes.
ContextConfigurationAttributes(java.lang.Class<?> declaringClass, java.lang.String[] locations, java.lang.Class<?>[] classes, boolean inheritLocations, java.lang.Class<? extends ContextLoader> contextLoaderClass) Deprecated. as of Spring 3.2, use ContextConfigurationAttributes(Class, String[], Class[], boolean, Class[], boolean, String, Class) instead

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determine if the supplied object is equal to this ContextConfigurationAttributes instance by comparing both object's declaring class, locations, annotated classes, inheritLocations flag, context initializer classes, inheritInitializers flag, and the ContextLoader class.
java.lang.Class<?>[]	getClasses() Get the annotated classes that were declared via @ContextConfiguration.
java.lang.Class<? extends ContextLoader>	getContextLoaderClass() Get the ContextLoader class that was declared via @ContextConfiguration.
java.lang.Class<?>	getDeclaringClass() Get the class that declared the @ContextConfiguration annotation.
java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[]	getInitializers() Get the ApplicationContextInitializer classes that were declared via @ContextConfiguration.
java.lang.String[]	getLocations() Get the resource locations that were declared via @ContextConfiguration.
java.lang.String	getName() Get the name of the context hierarchy level that was declared via @ContextConfiguration.
boolean	hasClasses() Determine if this ContextConfigurationAttributes instance has class-based resources.
int	hashCode() Generate a unique hash code for all properties of this ContextConfigurationAttributes instance excluding the name.
boolean	hasLocations() Determine if this ContextConfigurationAttributes instance has path-based resource locations.
boolean	hasResources() Determine if this ContextConfigurationAttributes instance has either path-based resource locations or class-based resources.
boolean	isInheritInitializers() Get the inheritInitializers flag that was declared via @ContextConfiguration.
boolean	isInheritLocations() Get the inheritLocations flag that was declared via @ContextConfiguration.
private static java.lang.String[]	resolveLocations(java.lang.Class<?> declaringClass, ContextConfiguration contextConfiguration) Resolve resource locations from the locations and value attributes of the supplied ContextConfiguration annotation.
void	setClasses(java.lang.Class<?>[] classes) Set the processed annotated classes, effectively overriding the original value declared via @ContextConfiguration.
void	setLocations(java.lang.String[] locations) Set the processed resource locations, effectively overriding the original value declared via @ContextConfiguration.
java.lang.String	toString() Provide a String representation of the context configuration attributes and declaring class.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Log logger

declaringClass

private final java.lang.Class<?> declaringClass

locations

private java.lang.String[] locations

classes

private java.lang.Class<?>[] classes

inheritLocations

private final boolean inheritLocations

contextLoaderClass

private final java.lang.Class<? extends ContextLoader> contextLoaderClass

initializers

private final java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] initializers

inheritInitializers

private final boolean inheritInitializers

name

private final java.lang.String name

Constructor Detail

ContextConfigurationAttributes

public ContextConfigurationAttributes(java.lang.Class<?> declaringClass,
                              ContextConfiguration contextConfiguration)

Construct a new ContextConfigurationAttributes instance for the supplied @ContextConfiguration annotation and the test class that declared it.

Parameters:

declaringClass - the test class that declared @ContextConfiguration

contextConfiguration - the annotation from which to retrieve the attributes

ContextConfigurationAttributes

@Deprecated
public ContextConfigurationAttributes(java.lang.Class<?> declaringClass,
                                         java.lang.String[] locations,
                                         java.lang.Class<?>[] classes,
                                         boolean inheritLocations,
                                         java.lang.Class<? extends ContextLoader> contextLoaderClass)

Deprecated. as of Spring 3.2, use ContextConfigurationAttributes(Class, String[], Class[], boolean, Class[], boolean, String, Class) instead

Construct a new ContextConfigurationAttributes instance for the test class that declared the @ContextConfiguration annotation and its corresponding attributes.

Parameters:

declaringClass - the test class that declared @ContextConfiguration

locations - the resource locations declared via @ContextConfiguration

classes - the annotated classes declared via @ContextConfiguration

inheritLocations - the inheritLocations flag declared via @ContextConfiguration

contextLoaderClass - the ContextLoader class declared via @ContextConfiguration

Throws:

java.lang.IllegalArgumentException - if the declaringClass or contextLoaderClass is null, or if the locations and classes are both non-empty

ContextConfigurationAttributes

public ContextConfigurationAttributes(java.lang.Class<?> declaringClass,
                              java.lang.String[] locations,
                              java.lang.Class<?>[] classes,
                              boolean inheritLocations,
                              java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] initializers,
                              boolean inheritInitializers,
                              java.lang.Class<? extends ContextLoader> contextLoaderClass)

Construct a new ContextConfigurationAttributes instance for the test class that declared the @ContextConfiguration annotation and its corresponding attributes.

Parameters:

declaringClass - the test class that declared @ContextConfiguration

locations - the resource locations declared via @ContextConfiguration

classes - the annotated classes declared via @ContextConfiguration

inheritLocations - the inheritLocations flag declared via @ContextConfiguration

initializers - the context initializers declared via @ContextConfiguration

inheritInitializers - the inheritInitializers flag declared via @ContextConfiguration

contextLoaderClass - the ContextLoader class declared via @ContextConfiguration

Throws:

java.lang.IllegalArgumentException - if the declaringClass or contextLoaderClass is null, or if the locations and classes are both non-empty

ContextConfigurationAttributes

public ContextConfigurationAttributes(java.lang.Class<?> declaringClass,
                              java.lang.String[] locations,
                              java.lang.Class<?>[] classes,
                              boolean inheritLocations,
                              java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] initializers,
                              boolean inheritInitializers,
                              java.lang.String name,
                              java.lang.Class<? extends ContextLoader> contextLoaderClass)

Construct a new ContextConfigurationAttributes instance for the test class that declared the @ContextConfiguration annotation and its corresponding attributes.

Parameters:

declaringClass - the test class that declared @ContextConfiguration

locations - the resource locations declared via @ContextConfiguration

classes - the annotated classes declared via @ContextConfiguration

inheritLocations - the inheritLocations flag declared via @ContextConfiguration

initializers - the context initializers declared via @ContextConfiguration

inheritInitializers - the inheritInitializers flag declared via @ContextConfiguration

name - the name of level in the context hierarchy, or null if not applicable

contextLoaderClass - the ContextLoader class declared via @ContextConfiguration

Throws:

java.lang.IllegalArgumentException - if the declaringClass or contextLoaderClass is null, or if the locations and classes are both non-empty

Method Detail

resolveLocations

private static java.lang.String[] resolveLocations(java.lang.Class<?> declaringClass,
                                  ContextConfiguration contextConfiguration)

Resolve resource locations from the locations and value attributes of the supplied ContextConfiguration annotation.

Throws:

java.lang.IllegalStateException - if both the locations and value attributes have been declared

getDeclaringClass

public java.lang.Class<?> getDeclaringClass()

Get the class that declared the @ContextConfiguration annotation.

Returns:

the declaring class; never null

getLocations

public java.lang.String[] getLocations()

Get the resource locations that were declared via @ContextConfiguration.

Note: this is a mutable property. The returned value may therefore represent a processed value that does not match the original value declared via @ContextConfiguration.

Returns:

the resource locations; potentially null or empty

See Also:

ContextConfiguration.value(), ContextConfiguration.locations(), setLocations(String[])

setLocations

public void setLocations(java.lang.String[] locations)

Set the processed resource locations, effectively overriding the original value declared via @ContextConfiguration.

See Also:

getLocations()

getClasses

public java.lang.Class<?>[] getClasses()

Get the annotated classes that were declared via @ContextConfiguration.

Note: this is a mutable property. The returned value may therefore represent a processed value that does not match the original value declared via @ContextConfiguration.

Returns:

the annotated classes; potentially null or empty

See Also:

ContextConfiguration.classes(), setClasses(Class[])

setClasses

public void setClasses(java.lang.Class<?>[] classes)

Set the processed annotated classes, effectively overriding the original value declared via @ContextConfiguration.

See Also:

getClasses()

hasLocations

public boolean hasLocations()

Determine if this ContextConfigurationAttributes instance has path-based resource locations.

Returns:

true if the locations array is not empty

See Also:

hasResources(), hasClasses()

hasClasses

public boolean hasClasses()

Determine if this ContextConfigurationAttributes instance has class-based resources.

Returns:

true if the classes array is not empty

See Also:

hasResources(), hasLocations()

hasResources

public boolean hasResources()

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

Returns:

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

See Also:

hasLocations(), hasClasses()

isInheritLocations

public boolean isInheritLocations()

Get the inheritLocations flag that was declared via @ContextConfiguration.

Returns:

the inheritLocations flag

See Also:

ContextConfiguration.inheritLocations()

getInitializers

public java.lang.Class<? extends ApplicationContextInitializer<? extends ConfigurableApplicationContext>>[] getInitializers()

Get the ApplicationContextInitializer classes that were declared via @ContextConfiguration.

Returns:

the ApplicationContextInitializer classes

Since:

3.2

isInheritInitializers

public boolean isInheritInitializers()

Get the inheritInitializers flag that was declared via @ContextConfiguration.

Returns:

the inheritInitializers flag

Since:

3.2

getContextLoaderClass

public java.lang.Class<? extends ContextLoader> getContextLoaderClass()

Get the ContextLoader class that was declared via @ContextConfiguration.

Returns:

the ContextLoader class

See Also:

ContextConfiguration.loader()

getName

public java.lang.String getName()

Get the name of the context hierarchy level that was declared via @ContextConfiguration.

Returns:

the name of the context hierarchy level or null if not applicable

Since:

3.2.2

See Also:

ContextConfiguration.name()

hashCode

public int hashCode()

Generate a unique hash code for all properties of this ContextConfigurationAttributes instance excluding the name.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Determine if the supplied object is equal to this ContextConfigurationAttributes instance by comparing both object's declaring class, locations, annotated classes, inheritLocations flag, context initializer classes, inheritInitializers flag, and the ContextLoader class.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Provide a String representation of the context configuration attributes and declaring class.

Overrides:

toString in class java.lang.Object