org.lsst.ccs.command.annotations

Annotation Type Command

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface Command

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

Author:

turri

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	alias Specify aliases for the command.
String	description Specify the description of the command.
int	level Specify the level of the command.
String	name If not null it will replace the method's name as the command name.
Command.CommandType	type The CommandType of the Command

Element Detail

name

public abstract String name

If not null it will replace the method's name as the command 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.

Returns:

command's description or "" if not set.

Default:

""

alias

public abstract String alias

Specify aliases for the command. Multiple aliases can be specified as a comma separated list.

Returns:

command's abbreviation(s) or "" if not set.

Default:

""

type

public abstract Command.CommandType type

The CommandType of the Command

Returns:

The command type.

Default:

org.lsst.ccs.command.annotations.Command.CommandType.ACTION

level

public abstract int level

Specify the level of the command. Only locks at the given level, or higher will have access to the command.

Returns:

the level of the Command. The default is zero.

Default:

0