org.lsst.ccs.framework.annotations

Annotation Type ConfigChanger

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ConfigChanger

marks a mutator ("setter") as being part of possible configuration change.

These methods will be dynamically reported by the module and calls in engineering mode are subject to a specific procedure. The ConfigChanger annotation has to be replaced by the Command annotation with type Command.CommandType.CONFIGURATION See https://jira.slac.stanford.edu/browse/LSSTCCS-393

Author:

bamade

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	argNames the name of parameters in correct order, the type will be induced by introspection, normally mutators have only one argument so this is not needed, but in some cases there may be mutators that change a set of parameters in the same invocation (for instance for synchronization purposes).
String	doc A short explanation on what the configuration command does.
String	propertyName

Element Detail

argNames

public abstract String[] argNames

the name of parameters in correct order, the type will be induced by introspection, normally mutators have only one argument so this is not needed, but in some cases there may be mutators that change a set of parameters in the same invocation (for instance for synchronization purposes).

Returns:

Default:

{}

doc

public abstract String doc

A short explanation on what the configuration command does.

Returns:

Default:

""

propertyName

public abstract String propertyName

Default:

""