org.springframework.boot.test.util

Class TestPropertyValues

java.lang.Object

org.springframework.boot.test.util.TestPropertyValues

public final class TestPropertyValues
extends Object

Test utilities for adding properties. Properties can be applied to a Spring Environment or to the system environment.

Since:

2.0.0

Author:

Madhura Bhave, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestPropertyValues.Type The type of property source.

Method Summary

Modifier and Type	Method and Description
TestPropertyValues	and(String pair) Builder method to append another property pair the underlying map of properties.
TestPropertyValues	and(String name, String value) Builder method to append another property to the underlying map of properties.
void	applyTo(ConfigurableApplicationContext context) Add the properties from the underlying map to the environment owned by an ApplicationContext.
void	applyTo(ConfigurableEnvironment environment) Add the properties from the underlying map to the environment.
void	applyTo(ConfigurableEnvironment environment, TestPropertyValues.Type type) Add the properties from the underlying map to the environment using the specified property source type.
void	applyTo(ConfigurableEnvironment environment, TestPropertyValues.Type type, String name) Add the properties from the underlying map to the environment using the specified property source type and name.
<T> T	applyToSystemProperties(Callable<T> call) Add the properties to the system properties for the duration of the call, restoring previous values then the call completes.
static TestPropertyValues	empty() Return a new empty TestPropertyValues instance.
static TestPropertyValues	of(Iterable<String> pairs) Return a new TestPropertyValues with the underlying map populated with the given property pairs.
static TestPropertyValues	of(String... pairs) Return a new TestPropertyValues with the underlying map populated with the given property pairs.
static TestPropertyValues	ofPair(String name, String value) Return a new TestPropertyValues with the underlying map populated with the given property pair.

Methods inherited from class java.lang.Object

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

Method Detail

and

public TestPropertyValues and(String pair)

Builder method to append another property pair the underlying map of properties.

Parameters:

pair - The property pair to add

Returns:

the existing instance of TestPropertyValues

and

public TestPropertyValues and(String name,
                              String value)

Builder method to append another property to the underlying map of properties.

Parameters:

name - The property name

value - The property value

Returns:

the existing instance of TestPropertyValues

applyTo

public void applyTo(ConfigurableApplicationContext context)

Add the properties from the underlying map to the environment owned by an ApplicationContext.

Parameters:

context - the context with an environment to modify

applyTo

public void applyTo(ConfigurableEnvironment environment)

Add the properties from the underlying map to the environment. The default property source used is MapPropertySource.

Parameters:

environment - the environment that needs to be modified

applyTo

public void applyTo(ConfigurableEnvironment environment,
                    TestPropertyValues.Type type)

Add the properties from the underlying map to the environment using the specified property source type.

Parameters:

environment - the environment that needs to be modified

type - the type of PropertySource to be added. See TestPropertyValues.Type

applyTo

public void applyTo(ConfigurableEnvironment environment,
                    TestPropertyValues.Type type,
                    String name)

Add the properties from the underlying map to the environment using the specified property source type and name.

Parameters:

environment - the environment that needs to be modified

type - the type of PropertySource to be added. See TestPropertyValues.Type

name - the name for the property source

applyToSystemProperties

public <T> T applyToSystemProperties(Callable<T> call)

Add the properties to the system properties for the duration of the call, restoring previous values then the call completes.

Type Parameters:

T - the result type

Parameters:

call - the call to make

Returns:

the result of the call

empty

public static TestPropertyValues empty()

Return a new empty TestPropertyValues instance.

Returns:

an empty instance

ofPair

public static TestPropertyValues ofPair(String name,
                                        String value)

Return a new TestPropertyValues with the underlying map populated with the given property pair.

Parameters:

name - the property name

value - the property value

Returns:

the new instance

of

public static TestPropertyValues of(Iterable<String> pairs)

Return a new TestPropertyValues with the underlying map populated with the given property pairs. Name-value pairs can be specified with colon (":") or equals ("=") separators.

Parameters:

pairs - The key value pairs for properties that need to be added to the environment

Returns:

the new instance

of

public static TestPropertyValues of(String... pairs)

Return a new TestPropertyValues with the underlying map populated with the given property pairs. Name-value pairs can be specified with colon (":") or equals ("=") separators.

Parameters:

pairs - The key value pairs for properties that need to be added to the environment

Returns:

the new instance