org.springframework.shell.commands

Class HelpCommands

java.lang.Object

org.springframework.shell.commands.HelpCommands

All Implemented Interfaces:

Aware, ApplicationContextAware, CommandMarker

@Component
public class HelpCommands
extends Object
implements CommandMarker, ApplicationContextAware

Provides a listing of commands known to the shell.

Constructor Summary

Constructors

Constructor and Description
HelpCommands()

Method Summary

Methods

Modifier and Type	Method and Description
void	obtainHelp(String buffer)
void	setApplicationContext(ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommands

public HelpCommands()

Method Detail

obtainHelp

@CliCommand(value="help",
            help="List all commands usage")
public void obtainHelp(@CliOption(key={"","command"},optionContext="disable-string-converter availableCommands",help="Command name to provide help for")
                                  String buffer)

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException