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

接口 IterableConfigurationPropertySource

所有超级接口:

ConfigurationPropertySource, Iterable<ConfigurationPropertyName>

所有已知实现类:

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.

从以下版本开始:

2.0.0

作者:

Phillip Webb, Madhura Bhave

另请参阅:

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

方法概要

修饰符和类型	方法	说明
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.
default IterableConfigurationPropertySource	withPrefix(String prefix)	Return a variant of this source that supports a prefix.

从接口继承的方法 org.springframework.boot.context.properties.source.ConfigurationPropertySource

getConfigurationProperty, getUnderlyingSource

从接口继承的方法 java.lang.Iterable

forEach, spliterator

方法详细资料

iterator

default Iterator<ConfigurationPropertyName> iterator()

Return an iterator for the names managed by this source.

指定者:

iterator 在接口中 Iterable<ConfigurationPropertyName>

返回:

an iterator (never null)

stream

Stream<ConfigurationPropertyName> stream()

Returns a sequential Stream for the names managed by this source.

返回:

a stream of names (never null)

containsDescendantOf

default ConfigurationPropertyState containsDescendantOf(ConfigurationPropertyName name)

从接口复制的说明: 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.

指定者:

containsDescendantOf 在接口中 ConfigurationPropertySource

参数:

name - the name to check

返回:

if the source contains any descendants

filter

default IterableConfigurationPropertySource filter(Predicate<ConfigurationPropertyName> filter)

从接口复制的说明: ConfigurationPropertySource

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

指定者:

filter 在接口中 ConfigurationPropertySource

参数:

filter - the filter to match

返回:

a filtered ConfigurationPropertySource instance

withAliases

default IterableConfigurationPropertySource withAliases(ConfigurationPropertyNameAliases aliases)

从接口复制的说明: ConfigurationPropertySource

Return a variant of this source that supports name aliases.

指定者:

withAliases 在接口中 ConfigurationPropertySource

参数:

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

返回:

a ConfigurationPropertySource instance supporting name aliases

withPrefix

default IterableConfigurationPropertySource withPrefix(String prefix)

从接口复制的说明: ConfigurationPropertySource

Return a variant of this source that supports a prefix.

指定者:

withPrefix 在接口中 ConfigurationPropertySource

参数:

prefix - the prefix for properties in the source

返回:

a ConfigurationPropertySource instance supporting a prefix