io.smallrye.config

Class SmallRyeConfig

java.lang.Object

io.smallrye.config.SmallRyeConfig

All Implemented Interfaces:

Serializable, org.eclipse.microprofile.config.Config

public class SmallRyeConfig
extends Object
implements org.eclipse.microprofile.config.Config, Serializable

Author:

Jeff Mesnil (c) 2017 Red Hat inc.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SmallRyeConfig(List<org.eclipse.microprofile.config.spi.ConfigSource> configSources, Map<Type,org.eclipse.microprofile.config.spi.Converter<?>> converters) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addConfigSource(org.eclipse.microprofile.config.spi.ConfigSource configSource) Deprecated.
<T> T	convert(String value, Class<T> asType)
<T> T	getConfigMapping(Class<T> type)
<T> T	getConfigMapping(Class<T> type, String prefix)
ConfigMappings	getConfigMappings()
Iterable<org.eclipse.microprofile.config.spi.ConfigSource>	getConfigSources()
ConfigValue	getConfigValue(String name)
<T> org.eclipse.microprofile.config.spi.Converter<T>	getConverter(Class<T> asType)
<T,C extends Collection<T>> Optional<C>	getIndexedOptionalValues(String name, org.eclipse.microprofile.config.spi.Converter<T> converter, IntFunction<C> collectionFactory)
List<String>	getIndexedProperties(String property)
List<Integer>	getIndexedPropertiesIndexes(String property)
<T,C extends Collection<T>> C	getIndexedValues(String name, org.eclipse.microprofile.config.spi.Converter<T> converter, IntFunction<C> collectionFactory)
<T> Optional<T>	getOptionalValue(String name, Class<T> aClass)
<T> Optional<T>	getOptionalValue(String name, org.eclipse.microprofile.config.spi.Converter<T> converter)
<T> Optional<List<T>>	getOptionalValues(String propertyName, Class<T> propertyType)
<T,C extends Collection<T>> Optional<C>	getOptionalValues(String name, Class<T> itemClass, IntFunction<C> collectionFactory)
<T,C extends Collection<T>> Optional<C>	getOptionalValues(String name, org.eclipse.microprofile.config.spi.Converter<T> converter, IntFunction<C> collectionFactory)
List<String>	getProfiles()
Iterable<String>	getPropertyNames()
String	getRawValue(String name) Get the raw value of a configuration property.
<T> T	getValue(String name, Class<T> aClass)
<T> T	getValue(String name, org.eclipse.microprofile.config.spi.Converter<T> converter) This method handles calls from both Config.getValue(java.lang.String, java.lang.Class<T>) and Config.getOptionalValue(java.lang.String, java.lang.Class<T>). Calls from Config.getValue(java.lang.String, java.lang.Class<T>) should throw an Exception for each of the following: 1.
<T> List<T>	getValues(String propertyName, Class<T> propertyType)
<T,C extends Collection<T>> C	getValues(String name, Class<T> itemClass, IntFunction<C> collectionFactory)
<T,C extends Collection<T>> C	getValues(String name, org.eclipse.microprofile.config.spi.Converter<T> converter, IntFunction<C> collectionFactory)
boolean	rawValueEquals(String name, String expected) Determine whether the raw value of a configuration property is exactly equal to the expected given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmallRyeConfig

@Deprecated
protected SmallRyeConfig(List<org.eclipse.microprofile.config.spi.ConfigSource> configSources,
                                     Map<Type,org.eclipse.microprofile.config.spi.Converter<?>> converters)

Deprecated.

Method Detail

getValues

public <T> List<T> getValues(String propertyName,
                             Class<T> propertyType)

getValues

public <T,C extends Collection<T>> C getValues(String name,
                                               Class<T> itemClass,
                                               IntFunction<C> collectionFactory)

getValues

public <T,C extends Collection<T>> C getValues(String name,
                                               org.eclipse.microprofile.config.spi.Converter<T> converter,
                                               IntFunction<C> collectionFactory)

getIndexedValues

public <T,C extends Collection<T>> C getIndexedValues(String name,
                                                      org.eclipse.microprofile.config.spi.Converter<T> converter,
                                                      IntFunction<C> collectionFactory)

getIndexedProperties

public List<String> getIndexedProperties(String property)

getIndexedPropertiesIndexes

public List<Integer> getIndexedPropertiesIndexes(String property)

getValue

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

Specified by:

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

getValue

public <T> T getValue(String name,
                      org.eclipse.microprofile.config.spi.Converter<T> converter)

This method handles calls from both Config.getValue(java.lang.String, java.lang.Class<T>) and Config.getOptionalValue(java.lang.String, java.lang.Class<T>).

Calls from Config.getValue(java.lang.String, java.lang.Class<T>) should throw an Exception for each of the following:
1. IllegalArgumentException - if the property cannot be converted by the Converter to the specified type
2. NoSuchElementException - if the property is not defined
3. NoSuchElementException - if the property is defined as an empty string
4. NoSuchElementException - if the Converter returns null

Calls from Config.getOptionalValue(java.lang.String, java.lang.Class<T>) should only throw an Exception for #1 (IllegalArgumentException when the property cannot be converted to the specified type).

rawValueEquals

public boolean rawValueEquals(String name,
                              String expected)

Determine whether the raw value of a configuration property is exactly equal to the expected given value.

Parameters:

name - the property name (must not be null)

expected - the expected value (may be null)

Returns:

true if the values are equal, false otherwise

getConfigValue

@Experimental(value="Extension to the original ConfigSource to allow retrieval of additional metadata on config lookup")
public ConfigValue getConfigValue(String name)

getRawValue

public String getRawValue(String name)

Get the raw value of a configuration property.

Parameters:

name - the property name (must not be null)

Returns:

the raw value, or null if no property value was discovered for the given property name

getOptionalValue

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

Specified by:

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

getOptionalValue

public <T> Optional<T> getOptionalValue(String name,
                                        org.eclipse.microprofile.config.spi.Converter<T> converter)

getOptionalValues

public <T> Optional<List<T>> getOptionalValues(String propertyName,
                                               Class<T> propertyType)

getOptionalValues

public <T,C extends Collection<T>> Optional<C> getOptionalValues(String name,
                                                                 Class<T> itemClass,
                                                                 IntFunction<C> collectionFactory)

getOptionalValues

public <T,C extends Collection<T>> Optional<C> getOptionalValues(String name,
                                                                 org.eclipse.microprofile.config.spi.Converter<T> converter,
                                                                 IntFunction<C> collectionFactory)

getIndexedOptionalValues

public <T,C extends Collection<T>> Optional<C> getIndexedOptionalValues(String name,
                                                                        org.eclipse.microprofile.config.spi.Converter<T> converter,
                                                                        IntFunction<C> collectionFactory)

getConfigMappings

public ConfigMappings getConfigMappings()

getConfigMapping

@Experimental(value="ConfigMapping API to group configuration properties")
public <T> T getConfigMapping(Class<T> type)

getConfigMapping

@Experimental(value="ConfigMapping API to group configuration properties")
public <T> T getConfigMapping(Class<T> type,
                                                                                                         String prefix)

getPropertyNames

public Iterable<String> getPropertyNames()

Specified by:

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

getConfigSources

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

Specified by:

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

addConfigSource

@Deprecated
public void addConfigSource(org.eclipse.microprofile.config.spi.ConfigSource configSource)

Deprecated.

Add a configuration source to the configuration object. The list of configuration sources is re-sorted to insert the new source into the correct position. Configuration source wrappers configured with SmallRyeConfigBuilder.withWrapper(UnaryOperator) will not be applied.

Parameters:

configSource - the new config source (must not be null)

convert

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

getConverter

public <T> org.eclipse.microprofile.config.spi.Converter<T> getConverter(Class<T> asType)

getProfiles

@Experimental(value="To retrive active profiles")
public List<String> getProfiles()