org.openhubframework.openhub.api.configuration

Annotation Type ConfigurableValue

@Qualifier
 @Documented
 @Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface ConfigurableValue

Marks a configurable parameter as being eligible for system configuration.

Annotation is used to inject configuration parameter wrapper that encapsulates system property and resource provider.

Example how to use:

   @ConfigurableValue ("ohf.asynch.confirmation.intervalSec")
    private ConfigurationItem<Integer> interval;
 

Since:

2.0

Author:

Tomas Hanus

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	key The key as ID of system parameter to inject.
boolean	required Declares whether the annotated system parameter is required.
String	value Alias for key().

Element Detail

value

@AliasFor(value="key")
public abstract String value

Alias for key().

Intended to be used instead of key() when key() is not declared — for example: @ConfigurableValue("key.name") instead of @ConfigurableValue(key = "key.name").

Returns:

the key name of system parameter

See Also:

key()

Default:

""

key

@AliasFor(value="value")
public abstract String key

The key as ID of system parameter to inject.

Returns:

the key name of system parameter

See Also:

value()

Default:

""

required

public abstract boolean required

Declares whether the annotated system parameter is required.

Defaults is true.

Returns:

true if the parameter is required. false otherwise.

Default:

true