org.springframework.test.context.support

Class TestPropertySourceAttributes

java.lang.Object

org.springframework.test.context.support.TestPropertySourceAttributes

class TestPropertySourceAttributes
extends java.lang.Object

TestPropertySourceAttributes encapsulates the attributes declared via @TestPropertySource.

In addition to encapsulating declared attributes, TestPropertySourceAttributes also enforces configuration rules and detects default properties files.

Since:

4.1

Author:

Sam Brannen

See Also:

TestPropertySource, MergedTestPropertySources

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<?>	declaringClass
private boolean	inheritLocations
private boolean	inheritProperties
private java.lang.String[]	locations
private static Log	logger
private java.lang.String[]	properties

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TestPropertySourceAttributes(java.lang.Class<?> declaringClass, java.lang.String[] locations, boolean inheritLocations, java.lang.String[] properties, boolean inheritProperties)
(package private)	TestPropertySourceAttributes(java.lang.Class<?> declaringClass, TestPropertySource testPropertySource) Create a new TestPropertySourceAttributes instance for the supplied @TestPropertySource annotation and the test class that declared it, enforcing configuration rules and detecting a default properties file if necessary.

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	detectDefaultPropertiesFile(java.lang.Class<?> testClass) Detect a default properties file for the supplied class, as specified in the class-level Javadoc for TestPropertySource.
(package private) java.lang.Class<?>	getDeclaringClass() Get the class that declared @TestPropertySource.
(package private) java.lang.String[]	getLocations() Get the resource locations that were declared via @TestPropertySource.
(package private) java.lang.String[]	getProperties() Get the inlined properties that were declared via @TestPropertySource.
(package private) boolean	isInheritLocations() Get the inheritLocations flag that was declared via @TestPropertySource.
(package private) boolean	isInheritProperties() Get the inheritProperties flag that was declared via @TestPropertySource.
java.lang.String	toString() Provide a String representation of the @TestPropertySource attributes and declaring class.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Log logger

declaringClass

private final java.lang.Class<?> declaringClass

locations

private final java.lang.String[] locations

inheritLocations

private final boolean inheritLocations

properties

private final java.lang.String[] properties

inheritProperties

private final boolean inheritProperties

Constructor Detail

TestPropertySourceAttributes

TestPropertySourceAttributes(java.lang.Class<?> declaringClass,
                             TestPropertySource testPropertySource)

Create a new TestPropertySourceAttributes instance for the supplied @TestPropertySource annotation and the test class that declared it, enforcing configuration rules and detecting a default properties file if necessary.

Parameters:

declaringClass - the class that declared @TestPropertySource

testPropertySource - the annotation from which to retrieve the attributes

Since:

4.2

TestPropertySourceAttributes

private TestPropertySourceAttributes(java.lang.Class<?> declaringClass,
                                     java.lang.String[] locations,
                                     boolean inheritLocations,
                                     java.lang.String[] properties,
                                     boolean inheritProperties)

Method Detail

getDeclaringClass

java.lang.Class<?> getDeclaringClass()

Get the class that declared @TestPropertySource.

Returns:

the declaring class; never null

getLocations

java.lang.String[] getLocations()

Get the resource locations that were declared via @TestPropertySource.

Note: The returned value may represent a detected default that does not match the original value declared via @TestPropertySource.

Returns:

the resource locations; potentially null or empty

See Also:

TestPropertySource.value(), TestPropertySource.locations(), #setLocations(String[])

isInheritLocations

boolean isInheritLocations()

Get the inheritLocations flag that was declared via @TestPropertySource.

Returns:

the inheritLocations flag

See Also:

TestPropertySource.inheritLocations()

getProperties

java.lang.String[] getProperties()

Get the inlined properties that were declared via @TestPropertySource.

Returns:

the inlined properties; potentially null or empty

See Also:

TestPropertySource.properties()

isInheritProperties

boolean isInheritProperties()

Get the inheritProperties flag that was declared via @TestPropertySource.

Returns:

the inheritProperties flag

See Also:

TestPropertySource.inheritProperties()

toString

public java.lang.String toString()

Provide a String representation of the @TestPropertySource attributes and declaring class.

Overrides:

toString in class java.lang.Object

detectDefaultPropertiesFile

private static java.lang.String detectDefaultPropertiesFile(java.lang.Class<?> testClass)

Detect a default properties file for the supplied class, as specified in the class-level Javadoc for TestPropertySource.