Package io.smallrye.config

Class ConfigMappings

java.lang.Object

io.smallrye.config.ConfigMappings

public final class ConfigMappings
extends Object

Utility class for ConfigMapping annotated classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConfigMappings.ConfigClass	A representation of a ConfigMapping or @ConfigProperties.

Constructor Summary

Constructors

Constructor	Description
ConfigMappings()

Method Summary

Modifier and Type	Method	Description
static Map<String,ConfigMappingInterface.Property>	getProperties(ConfigMappings.ConfigClass configClass)	Constructs a representation of all ConfigMappingInterface.Property contained in a mapping class.
static PropertyNamesMatcher	propertyNamesMatcher(List<ConfigMappings.ConfigClass> configClasses)	Constructs a PropertyNamesMatcher with all the property names mapped by the specified list of mapping classes.
static void	registerConfigMappings(SmallRyeConfig config, Set<ConfigMappings.ConfigClass> configClasses)	Registers additional ConfigMapping annotated classes with a SmallRyeConfig instance.
static void	registerConfigProperties(SmallRyeConfig config, Set<ConfigMappings.ConfigClass> configClasses)	Registers additional ConfigProperties annotated classes with a SmallRyeConfig instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigMappings

public ConfigMappings()

Method Details

registerConfigMappings

public static void registerConfigMappings(SmallRyeConfig config,
 Set<ConfigMappings.ConfigClass> configClasses)
                                   throws ConfigValidationException

Registers additional ConfigMapping annotated classes with a SmallRyeConfig instance.

The recommended method of registering ConfigMapping is with a SmallRyeConfigBuilder.withMapping(Class). In certain cases, this is not possible (ex. a CDI runtime), where mapping classes can only be discovered after the Config instance creation.

Parameters:

config - the SmallRyeConfig instance

configClasses - a Set of ConfigMapping annotated classes with prefixes

Throws:

ConfigValidationException - if a ConfigMapping cannot be registed with the SmallRyeConfig instance

registerConfigProperties

public static void registerConfigProperties(SmallRyeConfig config,
 Set<ConfigMappings.ConfigClass> configClasses)
                                     throws ConfigValidationException

Registers additional ConfigProperties annotated classes with a SmallRyeConfig instance.

The recommended method of registering ConfigProperties is with a SmallRyeConfigBuilder.withMapping(Class). In certain cases, this is not possible (ex. a CDI runtime), where mapping classes can only be discovered after the Config instance creation.

Parameters:

config - the SmallRyeConfig instance

configClasses - a Set of ConfigProperties annotated classes with prefixes

Throws:

ConfigValidationException - if a ConfigProperties cannot be registed with the SmallRyeConfig instance

getProperties

public static Map<String,ConfigMappingInterface.Property> getProperties(ConfigMappings.ConfigClass configClass)

Constructs a representation of all ConfigMappingInterface.Property contained in a mapping class. The Map key is the full path to the ConfigMappingInterface.Property, including the mapping class prefix.

Parameters:

configClass - the ConfigMapping annotated class and String prefix

Returns:

a Map with all mapping class ConfigMappingInterface.Property

See Also:

• ConfigMappingInterface.getProperties(ConfigMappingInterface)

propertyNamesMatcher

public static PropertyNamesMatcher propertyNamesMatcher(List<ConfigMappings.ConfigClass> configClasses)

Constructs a PropertyNamesMatcher with all the property names mapped by the specified list of mapping classes.

Parameters:

configClasses - a list of ConfigMapping annotated classes

Returns:

a PropertyNamesMatcher to match names mapped by the mapping classes