io.permazen.cli.cmd

Interface Command

All Superinterfaces:

Parser<CliSession.Action>

All Known Implementing Classes:

AbstractCommand, AbstractKVCommand, AbstractRaftCommand, AbstractTransactionRaftCommand, CompareSchemasCommand, DecodeKeyCommand, DeleteSchemaVersionCommand, EvalCommand, HelpCommand, ImportCommand, InfoCommand, JsckCommand, KVGetCommand, KVLoadCommand, KVPutCommand, KVRemoveCommand, KVSaveCommand, LoadCommand, QuitCommand, RaftAddCommand, RaftFallbackForceStandaloneCommand, RaftFallbackStatusCommand, RaftRemoveCommand, RaftStartElectionCommand, RaftStatusCommand, RaftStepDownCommand, RegisterCommandCommand, RegisterFunctionCommand, SaveCommand, SetAllowNewSchemaCommand, SetHistoryFileCommand, SetSchemaVersionCommand, SetSessionModeCommand, SetValidationModeCommand, SetVerboseCommand, ShowAllSchemasCommand, ShowImportsCommand, ShowSchemaCommand, ShowVariablesCommand

public interface Command
extends Parser<CliSession.Action>

CliSession command.

See Also:

AbstractCommand

Method Summary

Modifier and Type	Method and Description
String	getHelpDetail() Get expanded help (typically multiple lines).
String	getHelpSummary() Get summarized help (typically a single line).
String	getName() Get the name of this command.
EnumSet<SessionMode>	getSessionModes() Get the SessionMode(s) supported by this command.
String	getUsage() Get command usage string.

Methods inherited from interface io.permazen.parse.Parser

applyIdentifierScope, parse

Method Detail

getName

String getName()

Get the name of this command.

Returns:

command name

getUsage

String getUsage()

Get command usage string.

Returns:

command usage string

getHelpSummary

String getHelpSummary()

Get summarized help (typically a single line).

Returns:

one line command summary

getHelpDetail

String getHelpDetail()

Get expanded help (typically multiple lines).

Returns:

detailed command description

getSessionModes

EnumSet<SessionMode> getSessionModes()

Get the SessionMode(s) supported by this command.

Returns:

set of supported SessionModes