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

public class InfoCommand
extends AbstractCommand
implements Session.Action

Field Summary

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

log, name, paramParser

Constructor Summary

Constructors

Constructor	Description
InfoCommand()

Method Summary

Modifier and Type	Method	Description
Session.Action	getAction(Session session, 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(Session session)	Perform some action using the given Session.

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

execute, getHelpDetail, getName, getParser, getUsage

Methods inherited from class java.lang.Object

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

Constructor Details

InfoCommand

public InfoCommand()

Method Details

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

getAction

public Session.Action getAction(Session session,
 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

params - parsed parameters indexed by name

Returns:

action to perform for the parsed command

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

run

public void run(Session session)
         throws Exception

Description copied from interface: Session.Action

Perform some action using the given Session.

Specified by:

run in interface Session.Action

Parameters:

session - current session

Throws:

Exception - if an error occurs