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

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface SubsystemCommand

Annotation for commands. Allows to specify the name of a command, otherwise method's name is used.

Author:

Optional Element Summary

String	abbrev Specify the shortcut name for the command.
String	description Specify the description of the command.
String	name Allows to override default command name, which is derived from method's name
SubsystemCommand.CommandType	type Specify the string to output before command's output, i.e.

name

public abstract String name

Allows to override default command name, which is derived from method's name

Returns:

"" or null if default name is used, user-specified name otherwise.

Default:

""

description

public abstract String description

Specify the description of the command. Default description (if this property is not set) says "methodName(Arg1Type, Arg2Type,...) : ReturnType".

Returns:

command's description or "" if not set.

Default:

""

abbrev

public abstract String abbrev

Specify the shortcut name for the command. If not set, if the name attribute is not set as well, the Shell takes the first letter of each word (void selectUser() --- select-user --- su).

Returns:

command's abbreviation or "" if not set.

Default:

""

type

public abstract SubsystemCommand.CommandType type

Specify the string to output before command's output, i.e. some explanations.

Returns:

command's header or "" if not set.

Default:

org.lsst.ccs.subsystem.command.annotations.SubsystemCommand.CommandType.QUERY