Package io.quarkus.runtime.annotations

Annotation Type ConfigItem

@Retention(RUNTIME)
@Target({FIELD,PARAMETER})
@Documented
public @interface ConfigItem

A single container configuration item.

Field Summary

Fields

Modifier and Type	Fields	Description
static String	ELEMENT_NAME	Constant value for name() indicating that the annotated element's name should be used as-is.
static String	HYPHENATED_ELEMENT_NAME	Constant value for name() indicating that the annotated element's name should be de-camel-cased and hyphenated, and then used.
static String	NO_DEFAULT	Constant value for defaultValue() indicating that no default value should be used (the value is a configuration group or it is Optional).
static String	PARENT	Constant value for name() indicating that the parent's name for the member referencing this item's group should be used as the name of this item.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	defaultValue	Specify the default value of the configuration item, if none is found in the configuration.
String	defaultValueDocumentation	Specify the default value documentation, when it cannot be expressed by defaultValue().
String	name	Specify the relative name of the configuration item.

Field Detail

ELEMENT_NAME

static final String ELEMENT_NAME

Constant value for name() indicating that the annotated element's name should be used as-is.

HYPHENATED_ELEMENT_NAME

static final String HYPHENATED_ELEMENT_NAME

Constant value for name() indicating that the annotated element's name should be de-camel-cased and hyphenated, and then used.

PARENT

static final String PARENT

Constant value for name() indicating that the parent's name for the member referencing this item's group should be used as the name of this item. This value is only valid for members of configuration groups.

NO_DEFAULT

static final String NO_DEFAULT

Constant value for defaultValue() indicating that no default value should be used (the value is a configuration group or it is Optional).

Element Detail

name

String name

Specify the relative name of the configuration item.

Returns:

the name

Default:

"<<hyphenated element name>>"

defaultValue

String defaultValue

Specify the default value of the configuration item, if none is found in the configuration.

Returns:

the default value

Default:

"<<no default>>"

defaultValueDocumentation

String defaultValueDocumentation

Specify the default value documentation, when it cannot be expressed by defaultValue(). For example, if your default only exists for the DEV mode, you can use "true (DEV)".

Returns:

the default value documentation

Default:

""