Package io.smallrye.config

Class ConfigMappingInterface

java.lang.Object

io.smallrye.config.ConfigMappingInterface

All Implemented Interfaces:

ConfigMappingMetadata

public final class ConfigMappingInterface
extends Object
implements ConfigMappingMetadata

The metadata reprensentation of a ConfigMapping annotated class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigMappingInterface.CollectionProperty
static class	ConfigMappingInterface.DefaultMethodProperty
static class	ConfigMappingInterface.GroupProperty
static class	ConfigMappingInterface.LeafProperty
static class	ConfigMappingInterface.MapProperty
static class	ConfigMappingInterface.MayBeOptionalProperty
static class	ConfigMappingInterface.OptionalProperty
static class	ConfigMappingInterface.PrimitiveProperty
static class	ConfigMappingInterface.Property
static class	ConfigMappingInterface.ToStringMethod

Method Summary

Modifier and Type	Method	Description
byte[]	getClassBytes()
String	getClassName()	Get the generated implementation class name.
static ConfigMappingInterface	getConfigurationInterface(Class<?> interfaceType)	Get the configuration interface information for the given interface class.
Class<?>	getInterfaceType()	Get the configuration interface type.
Map<String,Map<String,Set<String>>>	getNames()	Constructs a representation of all ConfigMappingInterface.Property names contained in the ConfigMappingInterface.
static Map<String,Map<String,Set<String>>>	getNames(ConfigMappingInterface configMapping)	Constructs a representation of all ConfigMappingInterface.Property names contained in the ConfigMappingInterface.
ConfigMapping.NamingStrategy	getNamingStrategy()
ConfigMappingInterface.Property[]	getProperties()	Get the array of ConfigMappingInterface.Property relative to this ConfigMappingInterface.
static Map<Class<?>,Map<String,Map<String,ConfigMappingInterface.Property>>>	getProperties(ConfigMappingInterface configMapping)	Constructs a representation of all ConfigMappingInterface.Property contained in the ConfigMappingInterface.
ConfigMappingInterface[]	getSuperTypes()	Get the array of ConfigMappingInterface super types relative to this ConfigMappingInterface.
boolean	hasNamingStrategy()

Methods inherited from class java.lang.Object

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

Method Detail

getConfigurationInterface

public static ConfigMappingInterface getConfigurationInterface(Class<?> interfaceType)

Get the configuration interface information for the given interface class. This information is cached.

Parameters:

interfaceType - the interface type (must not be null)

Returns:

the configuration interface, or null if the type does not appear to be a configuration interface

getInterfaceType

public Class<?> getInterfaceType()

Get the configuration interface type.

Specified by:

getInterfaceType in interface ConfigMappingMetadata

Returns:

the configuration interface type

getClassName

public String getClassName()

Get the generated implementation class name. The class name is the configuration interface type name, plus the hashcode of the configuration interface type name with the suffix Impl.

Specified by:

getClassName in interface ConfigMappingMetadata

Returns:

the generated implementation class name

getSuperTypes

public ConfigMappingInterface[] getSuperTypes()

Get the array of ConfigMappingInterface super types relative to this ConfigMappingInterface. The array includes all super types until java.lang.Object.

Returns:

the array of ConfigMappingInterface super types

getProperties

public ConfigMappingInterface.Property[] getProperties()

Get the array of ConfigMappingInterface.Property relative to this ConfigMappingInterface. The array includes all properties, including properties contributed by super types.

Returns:

the array of ConfigMappingInterface.Property

getNames

public Map<String,Map<String,Set<String>>> getNames()

Constructs a representation of all ConfigMappingInterface.Property names contained in the ConfigMappingInterface.

Returns:

a Map with the mapping properties names

See Also:

getNames(ConfigMappingInterface)

hasNamingStrategy

public boolean hasNamingStrategy()

getNamingStrategy

public ConfigMapping.NamingStrategy getNamingStrategy()

getClassBytes

public byte[] getClassBytes()

Specified by:

getClassBytes in interface ConfigMappingMetadata

getNames

public static Map<String,Map<String,Set<String>>> getNames(ConfigMappingInterface configMapping)

Constructs a representation of all ConfigMappingInterface.Property names contained in the ConfigMappingInterface.

• The first level Map key is each Class name that is part of the mapping
• The second level Map key is each String path
• The Set contains all ConfigMappingInterface.Property String names under the mapping path, including sub-elements and nested elements

The path names do not include the ConfigMapping.prefix() because the same ConfigMappingInterface can be registered for multiple prefixes.

The mapping class root ConfigMappingInterface.Property use the empty String for the path key.

Parameters:

configMapping - a ConfigMappingInterface representation of a ConfigMapping annotated class

Returns:

a Map with the mapping properties names

getProperties

public static Map<Class<?>,Map<String,Map<String,ConfigMappingInterface.Property>>> getProperties(ConfigMappingInterface configMapping)

Constructs a representation of all ConfigMappingInterface.Property contained in the ConfigMappingInterface.

• The first level Map key is each Class that is part of the mapping
• The second level Map key is each String path in the mapping to a ConfigMappingInterface.Property
• The third level Map key is each String ConfigMappingInterface.Property name under the mapping path, including sub-elements and nested elements

The path names do not include the ConfigMapping.prefix() because the same ConfigMappingInterface can be registered for multiple prefixes.

The mapping class root ConfigMappingInterface.Property use the empty String for the path key.

Parameters:

configMapping - a ConfigMappingInterface representation of a ConfigMapping annotated class

Returns:

a Map with ConfigMappingInterface.Property values