IterableConfigurationPropertySource (spring-boot 2.7.14)

All Superinterfaces:

ConfigurationPropertySource, java.lang.Iterable<ConfigurationPropertyName>

All Known Implementing Classes:

MapConfigurationPropertySource
```
public interface IterableConfigurationPropertySource
extends ConfigurationPropertySource, java.lang.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

See Also:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
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(java.util.function.Predicate<ConfigurationPropertyName> filter)` Return a filtered variant of this source, containing only names that match the given `Predicate`.
`default java.util.Iterator<ConfigurationPropertyName>`	`iterator()` Return an iterator for the `names` managed by this source.
`java.util.stream.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(java.lang.String prefix)` Return a variant of this source that supports a prefix.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - iterator
```
default java.util.Iterator<ConfigurationPropertyName> iterator()
```
    Return an iterator for the names managed by this source.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<ConfigurationPropertyName>
    
    Returns:
    
    an iterator (never null)
  - stream
```
java.util.stream.Stream<ConfigurationPropertyName> stream()
```
    Returns a sequential Stream for the names managed by this source.
    
    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(java.util.function.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
  - withPrefix
```
default IterableConfigurationPropertySource withPrefix(java.lang.String prefix)
```
    Description copied from interface: ConfigurationPropertySource
    
    Return a variant of this source that supports a prefix.
    
    Specified by:
    
    withPrefix in interface ConfigurationPropertySource
    
    Parameters:
    
    prefix - the prefix for properties in the source
    
    Returns:
    
    a ConfigurationPropertySource instance supporting a prefix

Interface IterableConfigurationPropertySource

Method Summary

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

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

stream

containsDescendantOf

filter

withAliases

withPrefix