public class Help extends CliHandlerBase
Destroyable.Util
Modifier and Type | Method and Description |
---|---|
org.osgl.Osgl.T2<java.lang.String,java.lang.String> |
commandLine()
Returns the command line information that is used to display the command in help.
|
void |
handle(CliContext context)
Invoke handler upon a cli context
|
java.util.List<org.osgl.Osgl.T2<java.lang.String,java.lang.String>> |
options()
Returns a list of options information to be displayed in help of this command.
|
boolean |
showHelp(java.lang.String command,
CliContext context) |
java.lang.String |
summary()
Returns the summary of the command.
|
static void |
updateMaxWidth(int width) |
appliedIn, apply, destroy, isDestroyed, releaseResources, scope
public static final Help INSTANCE
public void handle(CliContext context)
CliHandler
Invoke handler upon a cli context
context
- the cli contextpublic boolean showHelp(java.lang.String command, CliContext context)
public org.osgl.Osgl.T2<java.lang.String,java.lang.String> commandLine()
CliHandler
Returns the command line information that is used to display the command in help. For example the Help
command is
help [options] [command] show help message
Help
command should return $.T2(“help [options] [command]”, “show help message”)
public java.lang.String summary()
CliHandler
Returns the summary of the command. This is used to display the help information about this command. If null
or empty string returned, then there will be no summary section in the help for this command
summary
in interface CliHandler
summary
in class CliHandlerBase
public java.util.List<org.osgl.Osgl.T2<java.lang.String,java.lang.String>> options()
CliHandler
Returns a list of options information to be displayed in help of this command. E.g. the options of Help
command is
-s –system list system commands
-a –app list app commands
Help
should return a list of $.T2(“-s –system”, “list system commands”)
$.T2(“-a –app”, “list application commands”)
public static void updateMaxWidth(int width)
Copyright © 2014–2017 ActFramework. All rights reserved.