public class HelpCommand extends AbstractCommand
log, name, paramParser
Constructor and Description |
---|
HelpCommand(CliSession session) |
Modifier and Type | Method and Description |
---|---|
CliSession.Action |
getAction(CliSession session0,
ParseContext ctx,
boolean complete,
Map<String,Object> params)
Process command line parameters and return action.
|
String |
getHelpDetail()
Get expanded help (typically multiple lines).
|
String |
getHelpSummary()
Get summarized help (typically a single line).
|
protected Parser<?> |
getParser(String typeName)
Convert parameter spec type name into a
Parser . |
EnumSet<SessionMode> |
getSessionModes()
Get the
SessionMode (s) supported by this command. |
getExprParam, getExprParam, getName, getUsage, parse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyIdentifierScope
public HelpCommand(CliSession session)
public String getHelpSummary()
AbstractCommand
getHelpSummary
in interface Command
getHelpSummary
in class AbstractCommand
public String getHelpDetail()
AbstractCommand
The implementation in AbstractCommand
delegates to getHelpSummary()
.
getHelpDetail
in interface Command
getHelpDetail
in class AbstractCommand
public EnumSet<SessionMode> getSessionModes()
AbstractCommand
SessionMode
(s) supported by this command.
The implementation in AbstractCommand
returns an EnumSet
containing
SessionMode.CORE_API
and SessionMode.PERMAZEN
.
getSessionModes
in interface Command
getSessionModes
in class AbstractCommand
SessionMode
sprotected Parser<?> getParser(String typeName)
AbstractCommand
Parser
. Used for custom type names not supported by ParamParser
.
The implementation in AbstractCommand
supports all FieldType
s registered with the
database, plus:
getParser
in class AbstractCommand
typeName
- parameter type namepublic CliSession.Action getAction(CliSession session0, ParseContext ctx, boolean complete, Map<String,Object> params)
AbstractCommand
getAction
in class AbstractCommand
session0
- CLI sessionctx
- input to parsecomplete
- false if parse is "for real", true if only for tab completion calculationparams
- parsed parameters indexed by nameCopyright © 2022. All rights reserved.