org.springframework.boot.context.properties.source

Interface IterableConfigurationPropertySource

All Superinterfaces:

ConfigurationPropertySource, Iterable<ConfigurationPropertyName>

All Known Implementing Classes:

MapConfigurationPropertySource

public interface IterableConfigurationPropertySource
extends ConfigurationPropertySource, Iterable<ConfigurationPropertyName>

A ConfigurationPropertySource with a fully Iterable set of entries. Implementations of this interface must be able to iterate over all contained configuration properties. Any non-null result from ConfigurationPropertySource.getConfigurationProperty(ConfigurationPropertyName) must also have an equivalent entry in the iterator.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

See Also:

ConfigurationPropertyName, OriginTrackedValue, ConfigurationPropertySource.getConfigurationProperty(ConfigurationPropertyName), iterator(), stream()

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 IterableConfigurationPropertySource	filter(Predicate<ConfigurationPropertyName> filter) Return a filtered variant of this source, containing only names that match the given Predicate.
default Iterator<ConfigurationPropertyName>	iterator() Return an iterator for the names managed by this source.
Stream<ConfigurationPropertyName>	stream() Returns a sequential Stream for the names managed by this source.
default IterableConfigurationPropertySource	withAliases(ConfigurationPropertyNameAliases aliases) Return a variant of this source that supports name aliases.

Methods inherited from interface org.springframework.boot.context.properties.source.ConfigurationPropertySource

getConfigurationProperty, getUnderlyingSource

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

default Iterator<ConfigurationPropertyName> iterator()

Return an iterator for the names managed by this source. If it is not possible to determine the names an empty iterator may be returned.

Specified by:

iterator in interface Iterable<ConfigurationPropertyName>

Returns:

an iterator (never null)

stream

Stream<ConfigurationPropertyName> stream()

Returns a sequential Stream for the names managed by this source. If it is not possible to determine the names an empty stream may be returned.

Returns:

a stream of names (never null)

containsDescendantOf

default ConfigurationPropertyState containsDescendantOf(ConfigurationPropertyName name)

Description copied from interface: ConfigurationPropertySource

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.

Specified by:

containsDescendantOf in interface ConfigurationPropertySource

Parameters:

name - the name to check

Returns:

if the source contains any descendants

filter

default IterableConfigurationPropertySource filter(Predicate<ConfigurationPropertyName> filter)

Description copied from interface: ConfigurationPropertySource

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

Specified by:

filter in interface ConfigurationPropertySource

Parameters:

filter - the filter to match

Returns:

a filtered ConfigurationPropertySource instance

withAliases

default IterableConfigurationPropertySource withAliases(ConfigurationPropertyNameAliases aliases)

Description copied from interface: ConfigurationPropertySource

Return a variant of this source that supports name aliases.

Specified by:

withAliases in interface ConfigurationPropertySource

Parameters:

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

Returns:

a ConfigurationPropertySource instance supporting name aliases