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.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NOT_SET
static String	NULL

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	allowedValueProvider For arguments with a dynamic set of allowed values specify the name of the AllowedValueProvider that will return the list of allowed values The default is an empty string to specify that there is no provider.
String	defaultValue Default value for this Argument.
String	description One-sentence description of the parameter.
String	name Optional parameter name.

Field Detail

NULL

public static final String NULL

NOT_SET

public static final String NOT_SET

Element Detail

name

public abstract String name

Optional parameter name. If not set the argument name will be the default name of the method's argument. If the class file has been compiled with Java 8 compiler argument "-parameters", the default name will be as specified in the class file, otherwise it will be "argN" where N is the index of the argument in the method's definition.

Returns:

The name of the argument.

Default:

""

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:

"***NOT_SET_INITIAL_VALUE***"

allowedValueProvider

public abstract String allowedValueProvider

For arguments with a dynamic set of allowed values specify the name of the AllowedValueProvider that will return the list of allowed values The default is an empty string to specify that there is no provider.

Returns:

the name of the AllowedValueProvider.

Default:

""