org.springframework.shell.core.annotation
Annotation Type CliCommand


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

Annotates a method that provides a command to the shell.

Since:
1.0

Required Element Summary
 String[] value
           
 
Optional Element Summary
 String help
           
 

Element Detail

value

public abstract String[] value
Returns:
one or more strings which must serve as the start of a particular command in order to match this method (these must be unique within the entire application; if not unique, behaviour is not specified)

help

public abstract String help
Returns:
a help message for this command (the default is a blank String, which means there is no help)
Default:
""