org.springframework.boot.context.properties.source

Interface ConfigurationPropertySource

All Known Subinterfaces:

IterableConfigurationPropertySource

All Known Implementing Classes:

MapConfigurationPropertySource

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.
ConfigurationProperty	getConfigurationProperty(ConfigurationPropertyName name) Return a single ConfigurationProperty from the source or null if no property can be found.
Object	getUnderlyingSource() Return the underlying PropertySource.
default ConfigurationPropertySource	withAliases(ConfigurationPropertyNameAliases aliases) Return a variant of this source that supports name aliases.

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

getUnderlyingSource

Object getUnderlyingSource()

Return the underlying PropertySource.

Returns:

the underlying property source.