sirius.kernel.di.std

Annotation Type ConfigValue

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface ConfigValue

Reads the config value given in value and inserts in into the field, wearing this annotation.

Provides a shortcut for accessing the config (Sirius.getSettings()). Also it performs the appropriate conversion to the target type of the given field. A default value should be placed in the component config (which then can be overridden in the application.conf or instance.conf).

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Contains the dot separated path to the desired config value.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	required Determines if the value is required (will cause an error if not filled).

Element Detail

value

public abstract String value

Contains the dot separated path to the desired config value.

Returns:

the path for the value to fetch from the config

required

public abstract boolean required

Determines if the value is required (will cause an error if not filled).

Basically this should not happen, as it is a good practice to place a default value in the current component config.

Returns:

true if the value must be filled, false (default) otherwise.

Default:

false