io.permazen.cli.cmd

Class QuitCommand

java.lang.Object

io.permazen.cli.cmd.AbstractCommand

io.permazen.cli.cmd.QuitCommand

All Implemented Interfaces:

CliSession.Action, Command, Parser<CliSession.Action>

public class QuitCommand
extends AbstractCommand
implements CliSession.Action

Field Summary

Fields inherited from class io.permazen.cli.cmd.AbstractCommand

log, name, paramParser

Constructor Summary

Constructors

Constructor and Description
QuitCommand()

Method Summary

Modifier and Type	Method and Description
CliSession.Action	getAction(CliSession session, ParseContext ctx, boolean complete, Map<String,Object> params) Process command line parameters and return action.
String	getHelpSummary() Get summarized help (typically a single line).
EnumSet<SessionMode>	getSessionModes() Get the SessionMode(s) supported by this command.
void	run(CliSession session) Perform some action using the given CliSession while a transaction is open.

Methods inherited from class io.permazen.cli.cmd.AbstractCommand

getExprParam, getExprParam, getHelpDetail, getName, getParser, getUsage, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.permazen.parse.Parser

applyIdentifierScope

Constructor Detail

QuitCommand

public QuitCommand()

Method Detail

getHelpSummary

public String getHelpSummary()

Description copied from class: AbstractCommand

Get summarized help (typically a single line).

Specified by:

getHelpSummary in interface Command

Specified by:

getHelpSummary in class AbstractCommand

Returns:

one line command summary

getSessionModes

public EnumSet<SessionMode> getSessionModes()

Description copied from class: AbstractCommand

Get the SessionMode(s) supported by this command.

The implementation in AbstractCommand returns an EnumSet containing SessionMode.CORE_API and SessionMode.PERMAZEN.

Specified by:

getSessionModes in interface Command

Overrides:

getSessionModes in class AbstractCommand

Returns:

set of supported SessionModes

getAction

public CliSession.Action getAction(CliSession session,
                                   ParseContext ctx,
                                   boolean complete,
                                   Map<String,Object> params)

Description copied from class: AbstractCommand

Process command line parameters and return action.

Specified by:

getAction in class AbstractCommand

Parameters:

session - CLI session

ctx - input to parse

complete - false if parse is "for real", true if only for tab completion calculation

params - parsed parameters indexed by name

Returns:

action to perform for the parsed command

run

public void run(CliSession session)
         throws Exception

Description copied from interface: CliSession.Action

Perform some action using the given CliSession while a transaction is open.

Specified by:

run in interface CliSession.Action

Parameters:

session - session with open transaction

Throws:

Exception - if an error occurs