程序包 org.springframework.boot.context.properties.source

接口 ConfigurationPropertySource

所有已知子接口:

IterableConfigurationPropertySource

所有已知实现类:

MapConfigurationPropertySource

函数接口:

这是一个函数接口, 因此可用作 lambda 表达式或方法引用的赋值目标。

@FunctionalInterface
public interface ConfigurationPropertySource

A source of ConfigurationProperties.

从以下版本开始:

2.0.0

作者:

Phillip Webb, Madhura Bhave

另请参阅:

• ConfigurationPropertyName
• OriginTrackedValue
• getConfigurationProperty(ConfigurationPropertyName)

方法概要

修饰符和类型	方法	说明
default ConfigurationPropertyState	containsDescendantOf(ConfigurationPropertyName name)	Returns if the source contains any descendants of the specified name.
default ConfigurationPropertySource	filter(Predicate<ConfigurationPropertyName> filter)	Return a filtered variant of this source, containing only names that match the given Predicate.
static ConfigurationPropertySource	from(PropertySource<?> source)	Return a single new ConfigurationPropertySource adapted from the given Spring PropertySource or null if the source cannot be adapted.
ConfigurationProperty	getConfigurationProperty(ConfigurationPropertyName name)	Return a single ConfigurationProperty from the source or null if no property can be found.
default Object	getUnderlyingSource()	Return the underlying source that is actually providing the properties.
default ConfigurationPropertySource	withAliases(ConfigurationPropertyNameAliases aliases)	Return a variant of this source that supports name aliases.
default ConfigurationPropertySource	withPrefix(String prefix)	Return a variant of this source that supports a prefix.

方法详细资料

getConfigurationProperty

ConfigurationProperty getConfigurationProperty(ConfigurationPropertyName name)

Return a single ConfigurationProperty from the source or null if no property can be found.

参数:

name - the name of the property (must not be null)

返回:

the associated object or null.

containsDescendantOf

default ConfigurationPropertyState containsDescendantOf(ConfigurationPropertyName name)

Returns if the source contains any descendants of the specified name. May return ConfigurationPropertyState.PRESENT or ConfigurationPropertyState.ABSENT if an answer can be determined or ConfigurationPropertyState.UNKNOWN if it's not possible to determine a definitive answer.

参数:

name - the name to check

返回:

if the source contains any descendants

filter

default ConfigurationPropertySource filter(Predicate<ConfigurationPropertyName> filter)

Return a filtered variant of this source, containing only names that match the given Predicate.

参数:

filter - the filter to match

返回:

a filtered ConfigurationPropertySource instance

withAliases

default ConfigurationPropertySource withAliases(ConfigurationPropertyNameAliases aliases)

Return a variant of this source that supports name aliases.

参数:

aliases - a function that returns a stream of aliases for any given name

返回:

a ConfigurationPropertySource instance supporting name aliases

withPrefix

default ConfigurationPropertySource withPrefix(String prefix)

Return a variant of this source that supports a prefix.

参数:

prefix - the prefix for properties in the source

返回:

a ConfigurationPropertySource instance supporting a prefix

从以下版本开始:

2.5.0

getUnderlyingSource

default Object getUnderlyingSource()

Return the underlying source that is actually providing the properties.

返回:

the underlying property source or null.

from

static ConfigurationPropertySource from(PropertySource<?> source)

Return a single new ConfigurationPropertySource adapted from the given Spring PropertySource or null if the source cannot be adapted.

参数:

source - the Spring property source to adapt

返回:

an adapted source or null SpringConfigurationPropertySource

从以下版本开始:

2.4.0