io.smallrye.config

Class MapBackedConfigValueConfigSource

java.lang.Object

io.smallrye.config.common.AbstractConfigSource

io.smallrye.config.MapBackedConfigValueConfigSource

All Implemented Interfaces:

ConfigValueConfigSource, Serializable, org.eclipse.microprofile.config.spi.ConfigSource

Direct Known Subclasses:

ConfigValuePropertiesConfigSource

public abstract class MapBackedConfigValueConfigSource
extends AbstractConfigSource
implements ConfigValueConfigSource

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.eclipse.microprofile.config.spi.ConfigSource

CONFIG_ORDINAL, DEFAULT_ORDINAL

Constructor Summary

Constructors

Constructor and Description
MapBackedConfigValueConfigSource(String name, Map<String,ConfigValue> propertyMap)
MapBackedConfigValueConfigSource(String name, Map<String,ConfigValue> propertyMap, boolean copy) Construct a new instance.
MapBackedConfigValueConfigSource(String name, Map<String,ConfigValue> propertyMap, int defaultOrdinal)
MapBackedConfigValueConfigSource(String name, Map<String,ConfigValue> propertyMap, int defaultOrdinal, boolean copy) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
ConfigValue	getConfigValue(String propertyName) Return the ConfigValue for the specified property in this configuration source.
Map<String,ConfigValue>	getConfigValueProperties() Return the properties in this configuration source as a Map of String and ConfigValue.
Set<String>	getPropertyNames()

Methods inherited from class io.smallrye.config.common.AbstractConfigSource

getName, getOrdinal, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.smallrye.config.ConfigValueConfigSource

getProperties, getValue

Methods inherited from interface org.eclipse.microprofile.config.spi.ConfigSource

getName, getOrdinal

Constructor Detail

MapBackedConfigValueConfigSource

public MapBackedConfigValueConfigSource(String name,
                                        Map<String,ConfigValue> propertyMap)

MapBackedConfigValueConfigSource

public MapBackedConfigValueConfigSource(String name,
                                        Map<String,ConfigValue> propertyMap,
                                        boolean copy)

Construct a new instance. The config source will use a default ordinal of 100 and will use a copy of the given map if copy is true.

Parameters:

name - the config source name

propertyMap - the map to use

copy - true to copy the given map, false otherwise

MapBackedConfigValueConfigSource

public MapBackedConfigValueConfigSource(String name,
                                        Map<String,ConfigValue> propertyMap,
                                        int defaultOrdinal)

MapBackedConfigValueConfigSource

public MapBackedConfigValueConfigSource(String name,
                                        Map<String,ConfigValue> propertyMap,
                                        int defaultOrdinal,
                                        boolean copy)

Construct a new instance. The config source will use the given default ordinal, and will use a copy of the given map if copy is true.

Parameters:

name - the config source name

propertyMap - the map to use

defaultOrdinal - the default ordinal to use if one is not given in the map

copy - true to copy the given map, false otherwise

Method Detail

getPropertyNames

public Set<String> getPropertyNames()

Specified by:

getPropertyNames in interface org.eclipse.microprofile.config.spi.ConfigSource

getConfigValue

public ConfigValue getConfigValue(String propertyName)

Description copied from interface: ConfigValueConfigSource

Return the ConfigValue for the specified property in this configuration source.

Specified by:

getConfigValue in interface ConfigValueConfigSource

Parameters:

propertyName - the property name

Returns:

the ConfigValue, or null if the property is not present

getConfigValueProperties

public Map<String,ConfigValue> getConfigValueProperties()

Description copied from interface: ConfigValueConfigSource

Return the properties in this configuration source as a Map of String and ConfigValue.

Specified by:

getConfigValueProperties in interface ConfigValueConfigSource

Returns:

a map containing properties of this configuration source