org.springframework.boot

Class DefaultPropertiesPropertySource

java.lang.Object

org.springframework.core.env.PropertySource<T>

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

org.springframework.core.env.MapPropertySource

org.springframework.boot.DefaultPropertiesPropertySource

public class DefaultPropertiesPropertySource
extends MapPropertySource

MapPropertySource containing default properties contributed directly to a SpringApplication. By convention, the DefaultPropertiesPropertySource is always the last property source in the Environment.

Since:

2.4.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.env.PropertySource

PropertySource.StubPropertySource

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of the 'default properties' property source.

Fields inherited from class org.springframework.core.env.PropertySource

logger, name, source

Constructor Summary

Constructors

Constructor and Description
DefaultPropertiesPropertySource(Map<String,Object> source) Create a new DefaultPropertiesPropertySource with the given Map source.

Method Summary

Modifier and Type	Method and Description
static void	addOrMerge(Map<String,Object> source, MutablePropertySources sources) Add a new DefaultPropertiesPropertySource or merge with an existing one.
static boolean	hasMatchingName(PropertySource<?> propertySource) Return true if the given source is named 'defaultProperties'.
static void	ifNotEmpty(Map<String,Object> source, Consumer<DefaultPropertiesPropertySource> action) Create a consume a new DefaultPropertiesPropertySource instance if the provided source is not empty.
static void	moveToEnd(ConfigurableEnvironment environment) Move the 'defaultProperties' property source so that it's the last source in the given ConfigurableEnvironment.
static void	moveToEnd(MutablePropertySources propertySources) Move the 'defaultProperties' property source so that it's the last source in the given MutablePropertySources.

Methods inherited from class org.springframework.core.env.MapPropertySource

containsProperty, getProperty, getPropertyNames

Methods inherited from class org.springframework.core.env.PropertySource

equals, getName, getSource, hashCode, named, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of the 'default properties' property source.

See Also:

Constant Field Values

Constructor Detail

DefaultPropertiesPropertySource

public DefaultPropertiesPropertySource(Map<String,Object> source)

Create a new DefaultPropertiesPropertySource with the given Map source.

Parameters:

source - the source map

Method Detail

hasMatchingName

public static boolean hasMatchingName(PropertySource<?> propertySource)

Return true if the given source is named 'defaultProperties'.

Parameters:

propertySource - the property source to check

Returns:

true if the name matches

ifNotEmpty

public static void ifNotEmpty(Map<String,Object> source,
                              Consumer<DefaultPropertiesPropertySource> action)

Create a consume a new DefaultPropertiesPropertySource instance if the provided source is not empty.

Parameters:

source - the Map source

action - the action used to consume the DefaultPropertiesPropertySource

addOrMerge

public static void addOrMerge(Map<String,Object> source,
                              MutablePropertySources sources)

Add a new DefaultPropertiesPropertySource or merge with an existing one.

Parameters:

source - the Map source

sources - the existing sources

Since:

2.4.4

moveToEnd

public static void moveToEnd(ConfigurableEnvironment environment)

Move the 'defaultProperties' property source so that it's the last source in the given ConfigurableEnvironment.

Parameters:

environment - the environment to update

moveToEnd

public static void moveToEnd(MutablePropertySources propertySources)

Move the 'defaultProperties' property source so that it's the last source in the given MutablePropertySources.

Parameters:

propertySources - the property sources to update