gov.va.vinci.leo.descriptors

Annotation Type LeoConfigurationParameter

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Inherited
public @interface LeoConfigurationParameter

Marks a class field variable as a configuration parameter. Supported types include primitives, Strings, and objects with a single string parameter in the constructor. Parameter types are set from the field type. Field array variables are created as multi-valued parameters. User: Thomas Ginter Date: 10/22/14 Time: 16:14

Field Summary

Fields

Modifier and Type	Fields and Description
static String	FIELD_NAME The default name value if one is not set.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Description of the parameter.
boolean	mandatory Specifies whether or not this parameter is required.
String	name Name of the parameter.

Field Detail

FIELD_NAME

public static final String FIELD_NAME

The default name value if one is not set.

Element Detail

name

public abstract String name

Name of the parameter. If you do not specify a name then the field name will be used by default.

Returns:

name of the parameter.

Default:

"!FIELD_NAME!"

description

public abstract String description

Description of the parameter. Defaults to the empty string.

Returns:

the parameter description.

Default:

""

mandatory

public abstract boolean mandatory

Specifies whether or not this parameter is required. Defaults to false.

Returns:

true if the parameter is required.

Default:

false