org.lsst.ccs.commons.annotations

Annotation Type ConfigurationParameter

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

Fields of a class annotated with this annotation will be tracked down by the configuration service.

Author:

The lSST CCS Team

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	category The category this parameters belongs to.
String	description A description for this parameter.
boolean	isBuild Specifies if this parameter is needed to build the agent.
boolean	isFinal Specifies if this parameter can be changed at initialization phase only.
boolean	isReadOnly Specifies if this configuration parameter is to be treated as read-only.
String	name The name under which this parameter is known to the configuration service.
String	range A range constraint associated to this parameter.
String	units The units for this parameter.

Element Detail

description

public abstract String description

A description for this parameter.

Returns:

Default:

""

units

public abstract String units

The units for this parameter.

Returns:

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:

""

category

public abstract String category

The category this parameters belongs to.

Default:

""

range

public abstract String range

A range constraint associated to this parameter.

Returns:

a String representation of the range.

Default:

""

isFinal

public abstract boolean isFinal

Specifies if this parameter can be changed at initialization phase only. It is false by default.

Returns:

true if this parameter can be changed at initialization phase only, false otherwise.

Default:

false

isReadOnly

public abstract boolean isReadOnly

Specifies if this configuration parameter is to be treated as read-only. The configuration service will not try to set it, but it will monitor its value and publish it along when ConfigurationInfo data is published.

Default:

false

isBuild

public abstract boolean isBuild

Specifies if this parameter is needed to build the agent. Build configuration parameters will be set exclusively during the initial build configuration setting. It is false by default.

Returns:

true if this parameter can be changed only during the initial build configuration setting.

Default:

false