org.lsst.ccs.commons.annotations

Annotation Type ConfigurableParameter

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

Author:

The lSST CCS Team

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	defaultValue The default value assigned to this parameter at construction

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	category The category this parameters belongs to.
String	constraints A constraint as a String.
String	description
boolean	isStatic True if the parameter cannot be changed at runtime
int	level
String	name The name under which this parameter is known to the configuration service.
String	simpleName A simpler name for this parameter.

Element Detail

defaultValue

public abstract String defaultValue

The default value assigned to this parameter at construction

description

public abstract String description

Default:

""

name

public abstract String name

The name under which this parameter is known to the configuration service. If "" or not set, the name of the field itself is picked up.

Default:

""

simpleName

public abstract String simpleName

A simpler name for this parameter.

Default:

""

constraints

public abstract String constraints

A constraint as a String.

Default:

""

level

public abstract int level

Default:

0

isStatic

public abstract boolean isStatic

True if the parameter cannot be changed at runtime

Default:

false

category

public abstract String category

The category this parameters belongs to.

Default:

""