Package org.springframework.boot.context.properties.source

Class MapConfigurationPropertySource

java.lang.Object

org.springframework.boot.context.properties.source.MapConfigurationPropertySource

All Implemented Interfaces:

Iterable<ConfigurationPropertyName>, ConfigurationPropertySource, IterableConfigurationPropertySource

public class MapConfigurationPropertySource
extends Object
implements IterableConfigurationPropertySource

A ConfigurationPropertySource backed by a Map and using standard name mapping rules.

Since:

2.0.0

Author:

Phillip Webb, Madhura Bhave

Constructor Summary

Constructors

Constructor	Description
MapConfigurationPropertySource()	Create a new empty MapConfigurationPropertySource instance.
MapConfigurationPropertySource(Map<?,?> map)	Create a new MapConfigurationPropertySource instance with entries copies from the specified map.

Method Summary

Modifier and Type	Method	Description
ConfigurationProperty	getConfigurationProperty(ConfigurationPropertyName name)	Return a single ConfigurationProperty from the source or null if no property can be found.
Object	getUnderlyingSource()	Return the underlying source that is actually providing the properties.
Iterator<ConfigurationPropertyName>	iterator()	Return an iterator for the names managed by this source.
void	put(Object name, Object value)	Add an individual entry.
void	putAll(Map<?,?> map)	Add all entries from the specified map.
Stream<ConfigurationPropertyName>	stream()	Returns a sequential Stream for the names managed by this source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

containsDescendantOf, filter, withAliases, withPrefix

Constructor Details

MapConfigurationPropertySource

public MapConfigurationPropertySource()

Create a new empty MapConfigurationPropertySource instance.

MapConfigurationPropertySource

public MapConfigurationPropertySource(Map<?,?> map)

Create a new MapConfigurationPropertySource instance with entries copies from the specified map.

Parameters:

map - the source map

Method Details

putAll

public void putAll(Map<?,?> map)

Add all entries from the specified map.

Parameters:

map - the source map

put

public void put(Object name,
 Object value)

Add an individual entry.

Parameters:

name - the name

value - the value

getUnderlyingSource

public Object getUnderlyingSource()

Description copied from interface: ConfigurationPropertySource

Return the underlying source that is actually providing the properties.

Specified by:

getUnderlyingSource in interface ConfigurationPropertySource

Returns:

the underlying property source or null.

getConfigurationProperty

public ConfigurationProperty getConfigurationProperty(ConfigurationPropertyName name)

Description copied from interface: ConfigurationPropertySource

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

Specified by:

getConfigurationProperty in interface ConfigurationPropertySource

Parameters:

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

Returns:

the associated object or null.

iterator

public Iterator<ConfigurationPropertyName> iterator()

Description copied from interface: IterableConfigurationPropertySource

Return an iterator for the names managed by this source.

Specified by:

iterator in interface Iterable<ConfigurationPropertyName>

Specified by:

iterator in interface IterableConfigurationPropertySource

Returns:

an iterator (never null)

stream

public Stream<ConfigurationPropertyName> stream()

Description copied from interface: IterableConfigurationPropertySource

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

Specified by:

stream in interface IterableConfigurationPropertySource

Returns:

a stream of names (never null)