Package io.permazen.cli.cmd

Class AbstractCommand

java.lang.Object

io.permazen.cli.cmd.AbstractCommand

All Implemented Interfaces:

Command

Direct Known Subclasses:

AbstractKVCommand, AbstractRaftCommand, CompareSchemasCommand, InfoCommand, JsckCommand, LoadCommand, RaftFallbackForceStandaloneCommand, RaftFallbackStatusCommand, RemoveSchemaCommand, SaveCommand, SetAllowNewSchemaCommand, SetLogLevelCommand, SetSchemaRemovalCommand, SetSessionModeCommand, SetValidationModeCommand, SetVerboseCommand, ShowSchemaCommand

public abstract class AbstractCommand
extends Object
implements Command

Support superclass for CLI Command implementations.

See Also:

• Command

Field Summary

Fields

Modifier and Type	Field	Description
protected final Logger	log
protected final String	name
protected final ParamParser	paramParser

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCommand(String spec)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	execute(Session session, String name, List<String> params)	Execute this command.
protected abstract Session.Action	getAction(Session session, Map<String,Object> params)	Process command line parameters and return action.
String	getHelpDetail()	Get expanded help (typically multiple lines).
abstract String	getHelpSummary()	Get summarized help (typically a single line).
String	getName()	Get the name of this command.
protected Parser<?>	getParser(String typeName)	Convert parameter spec type name into a Parser.
EnumSet<SessionMode>	getSessionModes()	Get the SessionMode(s) supported by this command.
String	getUsage()	Get command usage string.

Methods inherited from class java.lang.Object

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

Field Details

log

protected final Logger log

name

protected final String name

paramParser

protected final ParamParser paramParser

Constructor Details

AbstractCommand

protected AbstractCommand(String spec)

Constructor.

Parameters:

spec - ParamParser spec string, possibly containing custom type names (see getParser())

Method Details

getName

public String getName()

Description copied from interface: Command

Get the name of this command.

Specified by:

getName in interface Command

Returns:

command name

getUsage

public String getUsage()

Get command usage string.

The implementation in AbstractCommand delegates to ParamParser.getUsage().

Specified by:

getUsage in interface Command

Returns:

command usage string

getHelpSummary

public abstract String getHelpSummary()

Get summarized help (typically a single line).

Specified by:

getHelpSummary in interface Command

Returns:

one line command summary

getHelpDetail

public String getHelpDetail()

Get expanded help (typically multiple lines).

The implementation in AbstractCommand delegates to getHelpSummary().

Specified by:

getHelpDetail in interface Command

Returns:

detailed command description

getSessionModes

public EnumSet<SessionMode> getSessionModes()

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

Returns:

set of supported SessionModes

execute

public int execute(Session session,
 String name,
 List<String> params)
            throws InterruptedException

Execute this command.

The implementation in AbstractCommand parses the parameters, delegates to getAction() to generate an action, and then executes the action.

Specified by:

execute in interface Command

Parameters:

session - CLI session

name - command name

params - command line arguments

Returns:

command return value

Throws:

InterruptedException - if the current thread is interrupted

getAction

protected abstract Session.Action getAction(Session session,
 Map<String,Object> params)

Process command line parameters and return action.

Parameters:

session - CLI session

params - parsed parameters indexed by name

Returns:

action to perform for the parsed command

Throws:

IllegalArgumentException - if parameters are invalid

getParser

protected Parser<?> getParser(String typeName)

Convert parameter spec type name into a Parser. Used for custom type names not supported by ParamParser.

The implementation in AbstractCommand supports all Encodings registered with the database, plus:

• objid for an object ID of the form 64e8f29755302fe1 (returns ObjId)

Parameters:

typeName - parameter encoding ID or encoding ID alias

Returns:

parser for parameters of the specified type