Package io.helidon.microprofile.config

Class MpConfig

java.lang.Object

io.helidon.microprofile.config.MpConfig

All Implemented Interfaces:

org.eclipse.microprofile.config.Config

public class MpConfig
extends java.lang.Object
implements org.eclipse.microprofile.config.Config

Microprofile config wrapper of Config.

Constructor Summary

Constructors

Constructor	Description
MpConfig(Config config, java.util.List<org.eclipse.microprofile.config.spi.ConfigSource> mpConfigSources, java.util.Set<java.lang.Class> converterClasses, java.util.Map<java.lang.Class<?>,org.eclipse.microprofile.config.spi.Converter<?>> converters)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
<T> java.util.List<T>	asList(java.lang.String propertyName, java.lang.Class<T> typeArg)	Return value as a List of values.
java.util.Map<java.lang.String,java.lang.String>	asMap()	Get all properties of this config as a map.
<T> java.util.Set<T>	asSet(java.lang.String propertyName, java.lang.Class<T> typeArg)	Return value as a Set of values.
static MpConfigBuilder	builder()	Get a builder for config instances.
<T> T	convert(java.lang.Class<T> type, java.lang.String value)	Try to coerce the value to the specific type.
Config	getConfig()	Get an instance of Helidon config (a tree structure) rather than the microprofile config.
java.lang.Iterable<org.eclipse.microprofile.config.spi.ConfigSource>	getConfigSources()
<T> java.util.Optional<T>	getOptionalValue(java.lang.String propertyName, java.lang.Class<T> propertyType)
java.lang.Iterable<java.lang.String>	getPropertyNames()
<T> T	getValue(java.lang.String propertyName, java.lang.Class<T> propertyType)
<T> T	getValue(java.lang.String propertyName, java.lang.Class<T> propertyType, T defaultValue)	Get value with a default if it does not exist.
<T> T	getValueWithDefault(java.lang.String propertyName, java.lang.Class<T> propertyType, java.lang.String defaultValue)	Get value with a default if it does not exist.
boolean	hasConverter(java.lang.Class<?> clazz)	Check whether a converter exists for a specific class.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MpConfig

public MpConfig(Config config,
                java.util.List<org.eclipse.microprofile.config.spi.ConfigSource> mpConfigSources,
                java.util.Set<java.lang.Class> converterClasses,
                java.util.Map<java.lang.Class<?>,org.eclipse.microprofile.config.spi.Converter<?>> converters)

Create a new instance.

Parameters:

config - configuration

mpConfigSources - config sources

converterClasses - classes of converters

converters - class to converter mapping

Method Detail

builder

public static MpConfigBuilder builder()

Get a builder for config instances.

Returns:

a new builder

getValue

public <T> T getValue(java.lang.String propertyName,
                      java.lang.Class<T> propertyType)

Specified by:

getValue in interface org.eclipse.microprofile.config.Config

asSet

public <T> java.util.Set<T> asSet(java.lang.String propertyName,
                                  java.lang.Class<T> typeArg)

Return value as a Set of values.

Type Parameters:

T - type of elements

Parameters:

propertyName - name of property

typeArg - type of elements in the set

Returns:

set with elements found in properties

asList

public <T> java.util.List<T> asList(java.lang.String propertyName,
                                    java.lang.Class<T> typeArg)

Return value as a List of values.

Type Parameters:

T - type of elements

Parameters:

propertyName - name of property

typeArg - type of elements in the list

Returns:

list with elements found in properties

getValue

public <T> T getValue(java.lang.String propertyName,
                      java.lang.Class<T> propertyType,
                      T defaultValue)

Get value with a default if it does not exist.

Type Parameters:

T - type of the property

Parameters:

propertyName - name of the property

propertyType - type of the property

defaultValue - default value correctly typed

Returns:

value from configuration or default value if not available

getValueWithDefault

public <T> T getValueWithDefault(java.lang.String propertyName,
                                 java.lang.Class<T> propertyType,
                                 java.lang.String defaultValue)

Get value with a default if it does not exist.

Type Parameters:

T - type of the property

Parameters:

propertyName - name of the property

propertyType - type of the property

defaultValue - default value as String

Returns:

value from configuration or default value coerced to correct type if not available

getOptionalValue

public <T> java.util.Optional<T> getOptionalValue(java.lang.String propertyName,
                                                  java.lang.Class<T> propertyType)

Specified by:

getOptionalValue in interface org.eclipse.microprofile.config.Config

getPropertyNames

public java.lang.Iterable<java.lang.String> getPropertyNames()

Specified by:

getPropertyNames in interface org.eclipse.microprofile.config.Config

getConfigSources

public java.lang.Iterable<org.eclipse.microprofile.config.spi.ConfigSource> getConfigSources()

Specified by:

getConfigSources in interface org.eclipse.microprofile.config.Config

hasConverter

public boolean hasConverter(java.lang.Class<?> clazz)

Check whether a converter exists for a specific class.

Parameters:

clazz - class to convert to

Returns:

true if a converter exists for the specified class

convert

public <T> T convert(java.lang.Class<T> type,
                     java.lang.String value)

Try to coerce the value to the specific type.

Type Parameters:

T - type we expect (e.g. String, Integer or a java bean)

Parameters:

type - type to return

value - string value to parse

Returns:

null if value is null, transformed object otherwise

Throws:

java.lang.IllegalArgumentException - if the value cannot be converted to the specified type using.

getConfig

public Config getConfig()

Get an instance of Helidon config (a tree structure) rather than the microprofile config.

Returns:

config instance that has the same properties as this instance

asMap

public java.util.Map<java.lang.String,java.lang.String> asMap()

Get all properties of this config as a map.

Returns:

map where keys are configuration keys and values are associated string values

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object