org.lsst.ccs.shell
Annotation Type Param

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

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

Required Element Summary

String

name Parameter name.

Optional Element Summary

String

description One-sentence description of the parameter.

Element Detail

name

public abstract String name

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.

description

public abstract String description

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

Returns:

"Short description attribute" of the annotated parameter.

Default:

""