io.permazen.cli.cmd

Class HelpCommand

java.lang.Object

io.permazen.cli.cmd.AbstractCommand

io.permazen.cli.cmd.HelpCommand

All Implemented Interfaces:

Command, Parser<CliSession.Action>

public class HelpCommand
extends AbstractCommand

Field Summary

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

log, name, paramParser

Constructor Summary

Constructors

Constructor and Description
HelpCommand(CliSession session)

Method Summary

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.

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

getExprParam, getExprParam, getName, 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

HelpCommand

public HelpCommand(CliSession session)

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

getHelpDetail

public String getHelpDetail()

Description copied from class: AbstractCommand

Get expanded help (typically multiple lines).

The implementation in AbstractCommand delegates to getHelpSummary().

Specified by:

getHelpDetail in interface Command

Overrides:

getHelpDetail in class AbstractCommand

Returns:

detailed command description

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

getParser

protected Parser<?> getParser(String typeName)

Description copied from class: AbstractCommand

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

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

• type for an object type name (returns Integer)
• objid for an object ID of the form 64e8f29755302fe1 (returns ObjId)
• expr for an arbitrary Java expression

Overrides:

getParser in class AbstractCommand

Parameters:

typeName - parameter type name

Returns:

parser for parameters of the specified type

getAction

public CliSession.Action getAction(CliSession session0,
                                   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:

session0 - 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