@ShellComponent public class Help extends AbstractShellComponent
| Modifier and Type | Class and Description | 
|---|---|
| static interface  | Help.CommandMarker interface for beans providing help functionality to the shell. | 
| Constructor and Description | 
|---|
| Help(TemplateExecutor templateExecutor) | 
| Modifier and Type | Method and Description | 
|---|---|
| org.jline.utils.AttributedString | help(String command) | 
| void | setCommandsTemplate(String commandsTemplate)Sets a location for a template rendering commands help. | 
| void | setCommandTemplate(String commandTemplate)Sets a location for a template rendering command help. | 
| void | setShowGroups(boolean showGroups)Sets if groups should be shown in a listing, defaults to true. | 
afterPropertiesSet, getApplicationContext, getCommandCatalog, getCompletionResolver, getResourceLoader, getShell, getTemplateExecutor, getTerminal, getThemeResolver, setApplicationContext, setResourceLoaderpublic Help(TemplateExecutor templateExecutor)
@ShellMethod(value="Display help about available commands") public org.jline.utils.AttributedString help(@ShellOption(defaultValue="__NULL__",valueProvider=CommandValueProvider.class,value={"-C","--command"},help="The command to obtain help for.",arity=2147483647) String command) throws IOException
IOExceptionpublic void setCommandTemplate(String commandTemplate)
commandTemplate - the command template locationpublic void setCommandsTemplate(String commandsTemplate)
commandsTemplate - the commands template locationpublic void setShowGroups(boolean showGroups)
showGroups - the flag to show groupsCopyright © 2022. All rights reserved.