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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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.

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:

"--"