io.smallrye.config

Class SmallRyeConfigBuilder

java.lang.Object

io.smallrye.config.SmallRyeConfigBuilder

All Implemented Interfaces:

ConfigBuilder

public class SmallRyeConfigBuilder
extends Object
implements ConfigBuilder

Author:

Jeff Mesnil (c) 2017 Red Hat inc.

Constructor Summary

Constructors

Constructor and Description
SmallRyeConfigBuilder()

Method Summary

Modifier and Type	Method and Description
ConfigBuilder	addDefaultSources() Add the default config sources appearing on the builder's classpath including: System properties Environment properties /META-INF/microprofile-config.properties
ConfigBuilder	addDiscoveredConverters() Add the converters to be loaded via service loader pattern
ConfigBuilder	addDiscoveredSources() Add the config sources appearing to be loaded via service loader pattern
Config	build() Build the Config object.
ConfigBuilder	forClassLoader(ClassLoader classLoader) Return the ConfigBuilder for a given classloader
protected Config	newConfig(List<ConfigSource> sources, Map<Type,Converter> configConverters)
<T> ConfigBuilder	withConverter(Class<T> type, int priority, Converter<T> converter) Add the specified Converter for the given type.
ConfigBuilder	withConverters(Converter<?>[] converters) Add the specified Converter.
ConfigBuilder	withSources(ConfigSource... configSources) Add the specified ConfigSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmallRyeConfigBuilder

public SmallRyeConfigBuilder()

Method Detail

addDiscoveredSources

public ConfigBuilder addDiscoveredSources()

Description copied from interface: ConfigBuilder

Add the config sources appearing to be loaded via service loader pattern

Specified by:

addDiscoveredSources in interface ConfigBuilder

Returns:

the ConfigBuilder with the autodiscovered config sources

addDiscoveredConverters

public ConfigBuilder addDiscoveredConverters()

Description copied from interface: ConfigBuilder

Add the converters to be loaded via service loader pattern

Specified by:

addDiscoveredConverters in interface ConfigBuilder

Returns:

the ConfigBuilder with the autodiscovered converters

addDefaultSources

public ConfigBuilder addDefaultSources()

Description copied from interface: ConfigBuilder

Add the default config sources appearing on the builder's classpath including:

1. System properties
2. Environment properties
3. /META-INF/microprofile-config.properties

Specified by:

addDefaultSources in interface ConfigBuilder

Returns:

the ConfigBuilder with the default config sources

forClassLoader

public ConfigBuilder forClassLoader(ClassLoader classLoader)

Description copied from interface: ConfigBuilder

Return the ConfigBuilder for a given classloader

Specified by:

forClassLoader in interface ConfigBuilder

Parameters:

classLoader - the specified classloader

Returns:

the ConfigureBuilder for the given classloader

withSources

public ConfigBuilder withSources(ConfigSource... configSources)

Description copied from interface: ConfigBuilder

Add the specified ConfigSource.

Specified by:

withSources in interface ConfigBuilder

Parameters:

configSources - the config sources

Returns:

the ConfigBuilder with the configured sources

withConverters

public ConfigBuilder withConverters(Converter<?>[] converters)

Description copied from interface: ConfigBuilder

Add the specified Converter. This method uses reflection to determine what type the converter is for. When using lambda expressions for custom converters you should use ConfigBuilder.withConverter(Class, int, Converter) and pass the target type explicitly as lambda expressions do not offer enough type information to the reflection API.

Specified by:

withConverters in interface ConfigBuilder

Parameters:

converters - the converters

Returns:

the ConfigBuilder with the added converters

withConverter

public <T> ConfigBuilder withConverter(Class<T> type,
                                       int priority,
                                       Converter<T> converter)

Description copied from interface: ConfigBuilder

Add the specified Converter for the given type. This method does not rely on reflection to determine what type the converter is for therefore also lambda expressions can be used.

Specified by:

withConverter in interface ConfigBuilder

Type Parameters:

T - the type to convert

Parameters:

type - the Class of type to convert

priority - the priority of the converter (custom converters have a default priority of 100).

converter - the converter (can not be null)

Returns:

the ConfigBuilder with the added converters

build

public Config build()

Description copied from interface: ConfigBuilder

Build the Config object.

Specified by:

build in interface ConfigBuilder

Returns:

the Config object

newConfig

protected Config newConfig(List<ConfigSource> sources,
                           Map<Type,Converter> configConverters)