org.microbean.settings

Annotation Type Setting

@Documented
 @Qualifier
 @Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD,PARAMETER,TYPE})
public @interface Setting

A CDI Qualifier indicating that the annotated element should be provided via a Settings-originated value acquisition operation, such as Settings.get(String, Set, Converter, BiFunction).

Author:

Laird Nelson

See Also:

Settings.get(String, Set, Converter, BiFunction)

Field Summary

Fields

Modifier and Type	Fields and Description
static String	UNSET A value indicating null for use in annotation elements, since annotation elements cannot return or be set to null.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The setting name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue The default value for the setting.
boolean	required Whether a value for the setting must be present; it is illegal to set this to true and set the defaultValue element to a value other than UNSET

Field Detail

UNSET

public static final String UNSET

A value indicating null for use in annotation elements, since annotation elements cannot return or be set to null.

See Also:

defaultValue()

Element Detail

name

public abstract String name

The setting name.

Returns:

the setting name; never null but possibly UNSET

defaultValue

public abstract String defaultValue

The default value for the setting.

Returns:

the default value; never null but possibly UNSET

Default:

"\u2400"

required

public abstract boolean required

Whether a value for the setting must be present; it is illegal to set this to true and set the defaultValue element to a value other than UNSET

Returns:

whether a value for the setting must be present

Default:

false