Module io.helidon.pico.configdriven.api

Package io.helidon.pico.configdriven.api

Annotation Interface ConfiguredBy

@Documented
@Retention(CLASS)
@Target(TYPE)
@Qualifier
public @interface ConfiguredBy

In support of config-driven services. Place this on a service type interface where Singleton would typically go, for example as follows:

 
 @ConfiguredBy(MyConfigBean.class)
 public class MyConfiguredService {
     @Inject
     public MyConfiguredService(MyConfigBean cfg) {
         ...
     }
     ...
 }
 

See Also:

• ConfigBean

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<?>	value	The ConfigBean-annotated type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	drivesActivation	Determines whether an instance of this config bean in the registry will cause the backing service to be activated.
boolean	overrideBean	Required to be set to true if drivesActivation() is applied, thereby overriding the defaults in ConfigBean annotation.

Element Details

value

Class<?> value

The ConfigBean-annotated type.

Returns:

the ConfigBean-annotated type

overrideBean

boolean overrideBean

Required to be set to true if drivesActivation() is applied, thereby overriding the defaults in ConfigBean annotation. The default value is false.

Returns:

true to override the config bean attributes, false to defer to the bean

Default:

false

drivesActivation

boolean drivesActivation

Determines whether an instance of this config bean in the registry will cause the backing service to be activated. The default value is true. Note, however, that overrideBean() must be set to true for this to be applied.

Returns:

true if the presence of the config bean has an activation affect (aka, "config-driven services")

Default:

true