Package org.springframework.boot.context.config

Class ConfigData

java.lang.Object

org.springframework.boot.context.config.ConfigData

public final class ConfigData
extends Object

Configuration data that has been loaded from a ConfigDataResource and may ultimately contribute property sources to Spring's Environment.

Since:

2.4.0

Author:

Phillip Webb, Madhura Bhave

See Also:

• ConfigDataLocationResolver
• ConfigDataLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConfigData.Option	Option flags that can be applied.
static final class	ConfigData.Options	A set of ConfigData.Option flags.
static interface	ConfigData.PropertySourceOptions	Strategy interface used to supply ConfigData.Options for a given PropertySource.

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigData	EMPTY	A ConfigData instance that contains no data.

Constructor Summary

Constructors

Constructor	Description
ConfigData(Collection<? extends PropertySource<?>> propertySources, ConfigData.Option... options)	Create a new ConfigData instance with the same options applied to each source.
ConfigData(Collection<? extends PropertySource<?>> propertySources, ConfigData.PropertySourceOptions propertySourceOptions)	Create a new ConfigData instance with specific property source options.

Method Summary

Modifier and Type	Method	Description
ConfigData.Options	getOptions(PropertySource<?> propertySource)	Return the config data options that apply to the given source.
List<PropertySource<?>>	getPropertySources()	Return the configuration data property sources in ascending priority order.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final ConfigData EMPTY

A ConfigData instance that contains no data.

Constructor Details

ConfigData

public ConfigData(Collection<? extends PropertySource<?>> propertySources,
 ConfigData.Option... options)

Create a new ConfigData instance with the same options applied to each source.

Parameters:

propertySources - the config data property sources in ascending priority order.

options - the config data options applied to each source

See Also:

• ConfigData(Collection, PropertySourceOptions)

ConfigData

public ConfigData(Collection<? extends PropertySource<?>> propertySources,
 ConfigData.PropertySourceOptions propertySourceOptions)

Create a new ConfigData instance with specific property source options.

Parameters:

propertySources - the config data property sources in ascending priority order.

propertySourceOptions - the property source options

Since:

2.4.5

Method Details

getPropertySources

public List<PropertySource<?>> getPropertySources()

Return the configuration data property sources in ascending priority order. If the same key is contained in more than one of the sources, then the later source will win.

Returns:

the config data property sources

getOptions

public ConfigData.Options getOptions(PropertySource<?> propertySource)

Return the config data options that apply to the given source.

Parameters:

propertySource - the property source to check

Returns:

the options that apply

Since:

2.4.5