org.lsst.ccs.command.annotations

Annotation Type Option

@Repeatable(value=Option.List.class)
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface Option

Annotation for a Command Option. Allows to specify the name of a command Option. Options have a name and can be specified on the command line starting with a dash "-".

Author:

The LSST CCS Team

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the option as specified on the command line.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Specify the description of the Option.
String	singleLetterName The single letter name of the option as specified on the command line.

Element Detail

name

public abstract String name

The name of the option as specified on the command line. This name cannot be null or empty. Options can be invoked on the command line by using double slashes "--".

Returns:

The Option name.

description

public abstract String description

Specify the description of the Option.

Returns:

option's description or "" if not set.

Default:

""

singleLetterName

public abstract String singleLetterName

The single letter name of the option as specified on the command line. If unspecified the first letter of the name will be used. Single letter names can be used on the command line by using a single slash "-". Single letter names can be concatenated on the command line.

Returns:

The Option single letter name.

Default:

""