org.springframework.shell.standard.commands

Class Help

java.lang.Object

org.springframework.shell.standard.AbstractShellComponent

org.springframework.shell.standard.commands.Help

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ResourceLoaderAware

@ShellComponent
public class Help
extends AbstractShellComponent

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()

Method Summary

Modifier and Type	Method and Description
CharSequence	help(String command)
void	setShowGroups(boolean showGroups) Sets if groups should be shown in a listing, defaults to true.
void	setValidatorFactory(javax.validation.ValidatorFactory validatorFactory)

Methods inherited from class org.springframework.shell.standard.AbstractShellComponent

afterPropertiesSet, getApplicationContext, getCommandRegistry, getParameterResolver, getResourceLoader, getShell, getTemplateExecutor, getTerminal, getThemeResolver, setApplicationContext, setResourceLoader

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help()

Method Detail

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

setShowGroups

public void setShowGroups(boolean showGroups)

Sets if groups should be shown in a listing, defaults to true. If not enabled a simple list is shown without groups.

Parameters:

showGroups - the flag to show groups