org.lsst.ccs.subsystem.command.annotations
Annotation Type SubsystemCommandParameter

@Target(value=PARAMETER)
@Retention(value=RUNTIME)
public @interface SubsystemCommandParameter

Annotation for parameters of Command-marked methods. This annotation is of particular usefullness, because Java 5 Reflection doesn't have access to declared parameter names (there's simply no such information stored in classfile). You must at least provide name attribute, others being optional.

Author:

ASG

Optional Element Summary

String	getDescription One-sentence description of the parameter.
String	getName Parameter name.

getName

public abstract String getName

Parameter name. Should (1) reflect the original Java parameter name, (2) be short and descriptive to the user. Recommendations: "number-of-nodes", "user-login", "coefficients".

Returns:

The name ascribed to annotated method parameter.

Default:

""

getDescription

public abstract String getDescription

One-sentence description of the parameter. It is recommended that you always set it.

Returns:

"Short description attribute" of the annotated parameter.

Default:

""