org.springframework.shell.standard.commands

Class Help

java.lang.Object

org.springframework.shell.standard.commands.Help

@ShellComponent
public class Help
extends Object

A command to display help about all available commands.

Author:

Eric Bottard

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Help.Command Marker interface for beans providing help functionality to the shell.

Constructor Summary

Constructors

Constructor and Description
Help(List<ParameterResolver> parameterResolvers)

Method Summary

Modifier and Type	Method and Description
CharSequence	help(String command)
void	setCommandRegistry(CommandRegistry commandRegistry)
void	setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Help

@Autowired
public Help(List<ParameterResolver> parameterResolvers)

Method Detail

setCommandRegistry

@Autowired
public void setCommandRegistry(CommandRegistry commandRegistry)

setValidatorFactory

@Autowired(required=false)
public void setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)

help

@ShellMethod(value="Display help about available commands.",
             prefix="-")
public CharSequence help(@ShellOption(defaultValue="__NULL__",valueProvider=CommandValueProvider.class,value={"-C","--command"},help="The command to obtain help for.")
                                                                                                               String command)
                                                                                                        throws IOException

Throws:

IOException