org.springframework.shell.standard

Annotation Type ShellMethod

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

Used to mark a method as invokable via Spring Shell.

Author:

Eric Bottard, Florent Biville

Field Summary

Fields

Modifier and Type	Fields and Description
static String	INHERITED The default value for group(), meaning that the group will be inherited from the explicit value set on the containing element (class then package) or ultimately inferred.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	group The command group which this command belongs to.
InteractionMode	interactionMode Defines interaction mode for a command as a hint when command should be available.
String[]	key The name(s) by which this method can be invoked via Spring Shell.
String	prefix The prefix to use for assigning parameters by name.
String	value A description for the command.

Field Detail

INHERITED

public static final String INHERITED

The default value for group(), meaning that the group will be inherited from the explicit value set on the containing element (class then package) or ultimately inferred.

See Also:

ShellCommandGroup

Element Detail

key

public abstract String[] key

The name(s) by which this method can be invoked via Spring Shell. If not specified, the actual method name will be used (turning camelCase humps into "-").

Returns:

explicit command name(s) to use

Default:

{}

value

public abstract String value

A description for the command. Should not contain any formatting (e.g. html) characters and would typically start with a capital letter and end with a dot.

Returns:

short description of what the command does

Default:

""

prefix

public abstract String prefix

The prefix to use for assigning parameters by name.

Returns:

prefix to use when not specified as part of the parameter annotation

Default:

"--"

group

public abstract String group

The command group which this command belongs to. The command group is used when printing a list of commands to group related commands. By default, group is first looked up from owning class then package, and if not explicitly set, is inferred from class name.

Returns:

name of the command group

Default:

""

interactionMode

public abstract InteractionMode interactionMode

Defines interaction mode for a command as a hint when command should be available. For example presense of some commands doesn't make sense if shell is running as non-interactive mode and vice versa. Defaults to InteractionMode.ALL

Returns:

interaction mode

Default:

org.springframework.shell.context.InteractionMode.ALL