Class MockPropertySource

java.lang.Object

org.springframework.core.env.PropertySource<Map<String,Object>>

org.springframework.core.env.EnumerablePropertySource<Map<String,Object>>

org.springframework.core.env.MapPropertySource

org.springframework.core.env.PropertiesPropertySource

org.springframework.mock.env.MockPropertySource

public class MockPropertySource
extends PropertiesPropertySource

Simple PropertySource implementation for use in testing. Accepts a user-provided Properties object, or if omitted during construction, the implementation will initialize its own.

The setProperty(String, Object) and withProperty(String, Object) methods are exposed for convenience, for example:

  PropertySource<?> source = new MockPropertySource().withProperty("foo", "bar");

Since:

3.1

Author:

Chris Beams

See Also:

• MockEnvironment

Nested Class Summary

Nested classes/interfaces inherited from class PropertySource

PropertySource.StubPropertySource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MOCK_PROPERTIES_PROPERTY_SOURCE_NAME	"mockProperties" is the default name for MockPropertySource instances not otherwise given an explicit name.

Fields inherited from class PropertySource

logger, name, source

Constructor Summary

Constructors

Constructor	Description
MockPropertySource()	Create a new MockPropertySource named "mockProperties" that will maintain its own internal Properties instance.
MockPropertySource(String name)	Create a new MockPropertySource with the given name that will maintain its own internal Properties instance.
MockPropertySource(String name, Properties properties)	Create a new MockPropertySource with the given name and backed by the given Properties object.
MockPropertySource(Properties properties)	Create a new MockPropertySource named "mockProperties" and backed by the given Properties object.

Method Summary

Modifier and Type	Method	Description
void	setProperty(String name, Object value)	Set the given property on the underlying Properties object.
MockPropertySource	withProperty(String name, Object value)	Convenient synonym for setProperty(String, Object) that returns the current instance.

Methods inherited from class PropertiesPropertySource

getPropertyNames

Methods inherited from class MapPropertySource

containsProperty, getProperty

Methods inherited from class PropertySource

equals, getName, getSource, hashCode, named, toString

Methods inherited from class Object

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

Field Details

MOCK_PROPERTIES_PROPERTY_SOURCE_NAME

public static final String MOCK_PROPERTIES_PROPERTY_SOURCE_NAME

"mockProperties" is the default name for MockPropertySource instances not otherwise given an explicit name.

See Also:

• MockPropertySource()
• MockPropertySource(String)
• Constant Field Values

Constructor Details

MockPropertySource

public MockPropertySource()

Create a new MockPropertySource named "mockProperties" that will maintain its own internal Properties instance.

MockPropertySource

public MockPropertySource(String name)

Create a new MockPropertySource with the given name that will maintain its own internal Properties instance.

Parameters:

name - the name of the property source

MockPropertySource

public MockPropertySource(Properties properties)

Create a new MockPropertySource named "mockProperties" and backed by the given Properties object.

Parameters:

properties - the properties to use

MockPropertySource

public MockPropertySource(String name,
 Properties properties)

Create a new MockPropertySource with the given name and backed by the given Properties object.

Parameters:

name - the name of the property source

properties - the properties to use

Method Details

setProperty

public void setProperty(String name,
 Object value)

Set the given property on the underlying Properties object.

withProperty

public MockPropertySource withProperty(String name,
 Object value)

Convenient synonym for setProperty(String, Object) that returns the current instance.

Useful for method chaining and fluent-style use.

Returns:

this MockPropertySource instance