Package io.permazen.cli.cmd
Class InfoCommand
java.lang.Object
io.permazen.cli.cmd.AbstractCommand
io.permazen.cli.cmd.InfoCommand
- All Implemented Interfaces:
Command
,Session.Action
-
Field Summary
Fields inherited from class io.permazen.cli.cmd.AbstractCommand
log, name, paramParser
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionProcess command line parameters and return action.Get summarized help (typically a single line).Get theSessionMode
(s) supported by this command.void
Perform some action using the givenSession
.Methods inherited from class io.permazen.cli.cmd.AbstractCommand
execute, getHelpDetail, getName, getParser, getUsage
-
Constructor Details
-
InfoCommand
public InfoCommand()
-
-
Method Details
-
getHelpSummary
Description copied from class:AbstractCommand
Get summarized help (typically a single line).- Specified by:
getHelpSummary
in interfaceCommand
- Specified by:
getHelpSummary
in classAbstractCommand
- Returns:
- one line command summary
-
getAction
Description copied from class:AbstractCommand
Process command line parameters and return action.- Specified by:
getAction
in classAbstractCommand
- Parameters:
session
- CLI sessionparams
- parsed parameters indexed by name- Returns:
- action to perform for the parsed command
-
getSessionModes
Description copied from class:AbstractCommand
Get theSessionMode
(s) supported by this command.The implementation in
AbstractCommand
returns anEnumSet
containingSessionMode.CORE_API
andSessionMode.PERMAZEN
.- Specified by:
getSessionModes
in interfaceCommand
- Overrides:
getSessionModes
in classAbstractCommand
- Returns:
- set of supported
SessionMode
s
-
run
Description copied from interface:Session.Action
Perform some action using the givenSession
.- Specified by:
run
in interfaceSession.Action
- Parameters:
session
- current session- Throws:
Exception
- if an error occurs
-