Package de.fraunhofer.iosb.ilt.configurable.annotations

Annotation Type ConfigurableField

@Retention(RUNTIME)
@Target(FIELD)
public @interface ConfigurableField

Author:

Hylke van der Schaaf

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<? extends ConfigEditor>	editor	The class to use as editor for the annotated field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description	The description to use in the user interface.
String	jsonField	The name of the field in the configuration JSON to use for storing the value of the annotated field.
String	label	The label to use in the user interface.
boolean	merge	Merge the configuration of the field into the configuration of the Map holding the field.
boolean	optional
String	profilesGui	A comma separated, case insensitive list of profile names.
String	profilesSave	A comma separated, case insensitive list of profile names.

Element Detail

editor

Class<? extends ConfigEditor> editor

The class to use as editor for the annotated field. The editor should also supply an annotation type to use for defining further parameters.

Returns:

The class to use as editor for the annotated field.

label

String label

The label to use in the user interface. Defaults to the field name (case sensitive).

Returns:

The label to use in the user interface.

Default:

""

description

String description

The description to use in the user interface.

Returns:

The description to use in the user interface.

Default:

""

jsonField

String jsonField

The name of the field in the configuration JSON to use for storing the value of the annotated field. Defaults to the field name (case sensitive).

Returns:

The name of the field in the configuration JSON to use for storing the value of the annotated field.

Default:

""

optional

boolean optional

Default:

false

merge

boolean merge

Merge the configuration of the field into the configuration of the Map holding the field. This only works for fields that have a configuration of the JSON type Object.

Returns:

Merge the configuration of the field into the configuration of the Map holding the field.

Default:

false

profilesSave

String profilesSave

A comma separated, case insensitive list of profile names. This field is only included in the output json when one of these profiles is active. The "default" profile is automatically added to the list.

Returns:

A comma separated, case insensitive list of profile names.

Default:

""

profilesGui

String profilesGui

A comma separated, case insensitive list of profile names. This field is only included in the GUI when one of these profiles is active. The "default" profile is automatically added to the list.

Returns:

A comma separated, case insensitive list of profile names.

Default:

""