io.quarkus.arc.config

Annotation Type ConfigProperties

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ConfigProperties

Allow configuration properties with a common prefix to be grouped into a single class

Field Summary

Fields

Modifier and Type	Fields and Description
static String	UNSET_PREFIX

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ConfigProperties.NamingStrategy	namingStrategy The naming strategy to use for the corresponding property.
String	prefix If the default is used, the class name will be used to determine the proper prefix

Field Detail

UNSET_PREFIX

public static final String UNSET_PREFIX

Element Detail

prefix

public abstract String prefix

If the default is used, the class name will be used to determine the proper prefix

Default:

"<< unset >>"

namingStrategy

public abstract ConfigProperties.NamingStrategy namingStrategy

The naming strategy to use for the corresponding property. This only matters for fields or method names that contain both lower case and upper case characters. NamingStrategy.VERBATIM means that whatever the name of the field / method is, that will be the name of the property. NamingStrategy.KEBAB_CASE means that the name of property is derived by replacing case changes with a dash. For a example: /**

 @ConfigProperties(prefix="whatever")
 public class SomeConfig {
   public fooBar;
 }
 

Then to set the fooBar field, the corresponding property would be whatever.fooBar. If namingStrategy=NamingStrategy.KEBAB_CASE were being used, then the corresponding property would be whatever.foo-bar When this field is not set, then the default strategy will be determined by the value of quarkus.arc.config-properties-default-naming-strategy

Default:

io.quarkus.arc.config.ConfigProperties.NamingStrategy.FROM_CONFIG