io.smallrye.config

Class SmallRyeConfig

java.lang.Object

io.smallrye.config.SmallRyeConfig

All Implemented Interfaces:

Serializable, Config

public class SmallRyeConfig
extends Object
implements Config, Serializable

Author:

Jeff Mesnil (c) 2017 Red Hat inc.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SmallRyeConfig(List<ConfigSource> configSources, Map<Type,Converter> converters)

Method Summary

Modifier and Type	Method and Description
<T> T	convert(String value, Class<T> asType)
Iterable<ConfigSource>	getConfigSources()
protected <T> Converter	getConverter(Class<T> asType)
<T> Optional<T>	getOptionalValue(String name, Class<T> aClass) Return the resolved property value with the specified type for the specified property name from the underlying ConfigSources.
Iterable<String>	getPropertyNames() Return a collection of property names.
<T> T	getValue(String name, Class<T> aClass) Return the resolved property value with the specified type for the specified property name from the underlying ConfigSources.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmallRyeConfig

protected SmallRyeConfig(List<ConfigSource> configSources,
                         Map<Type,Converter> converters)

Method Detail

getValue

public <T> T getValue(String name,
                      Class<T> aClass)

Description copied from interface: Config

Return the resolved property value with the specified type for the specified property name from the underlying ConfigSources. If this method gets used very often then consider to locally store the configured value.

Specified by:

getValue in interface Config

Type Parameters:

T - The property type

Parameters:

name - The configuration propertyName.

aClass - The type into which the resolve property value should get converted

Returns:

the resolved property value as an object of the requested type.

getOptionalValue

public <T> Optional<T> getOptionalValue(String name,
                                        Class<T> aClass)

Description copied from interface: Config

Return the resolved property value with the specified type for the specified property name from the underlying ConfigSources. If this method is used very often then consider to locally store the configured value.

Specified by:

getOptionalValue in interface Config

Type Parameters:

T - The property type

Parameters:

name - The configuration propertyName.

aClass - The type into which the resolve property value should be converted

Returns:

The resolved property value as an Optional of the requested type.

getPropertyNames

public Iterable<String> getPropertyNames()

Description copied from interface: Config

Return a collection of property names.

Specified by:

getPropertyNames in interface Config

Returns:

the names of all configured keys of the underlying configuration.

getConfigSources

public Iterable<ConfigSource> getConfigSources()

Specified by:

getConfigSources in interface Config

Returns:

all currently registered configsources sorted with descending ordinal and ConfigSource name

convert

public <T> T convert(String value,
                     Class<T> asType)

getConverter

protected <T> Converter getConverter(Class<T> asType)