org.lsst.ccs.command.annotations

Annotation Type Argument

@Target(value=PARAMETER)
@Retention(value=RUNTIME)
@Documented
public @interface Argument

Annotation for parameters of Command-marked methods. This annotation is of particular usefulness, because Java 5 Reflection doesn't have access to declared parameter names (there's simply no such information stored in classfile).

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name Optional parameter name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue Default value for this Argument.
String	description One-sentence description of the parameter.

Element Detail

name

public abstract String name

Optional parameter name. If not set the argument name will be "arg0", "arg1"....

Returns:

The name of the argument.

description

public abstract String description

One-sentence description of the parameter.

Returns:

Short description of the annotated argument.

Default:

""

defaultValue

public abstract String defaultValue

Default value for this Argument.

Returns:

the default value for this Argument.

Default:

"***NULL_VALUE_FOR_COMMAND_ARGUMENT***"