org.springframework.boot.context.properties.source

Interface ConfigurationPropertySource

All Known Subinterfaces:

IterableConfigurationPropertySource

All Known Implementing Classes:

MapConfigurationPropertySource

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ConfigurationPropertySource

A source of ConfigurationProperties.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

See Also:

ConfigurationPropertyName, OriginTrackedValue, getConfigurationProperty(ConfigurationPropertyName)

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getConfigurationProperty

ConfigurationProperty getConfigurationProperty(ConfigurationPropertyName name)

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

Parameters:

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

Returns:

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.

Parameters:

name - the name to check

Returns:

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.

Parameters:

filter - the filter to match

Returns:

a filtered ConfigurationPropertySource instance

withAliases

default ConfigurationPropertySource withAliases(ConfigurationPropertyNameAliases aliases)

Return a variant of this source that supports name aliases.

Parameters:

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

Returns:

a ConfigurationPropertySource instance supporting name aliases

withPrefix

default ConfigurationPropertySource withPrefix(String prefix)

Return a variant of this source that supports a prefix.

Parameters:

prefix - the prefix for properties in the source

Returns:

a ConfigurationPropertySource instance supporting a prefix

Since:

2.5.0

getUnderlyingSource

default Object getUnderlyingSource()

Return the underlying source that is actually providing the properties.

Returns:

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.

Parameters:

source - the Spring property source to adapt

Returns:

an adapted source or null SpringConfigurationPropertySource

Since:

2.4.0