InfoCommand (JSimpleDB CLI Classes 2.4.2 API)

java.lang.Object
- org.jsimpledb.cli.cmd.AbstractCommand
- - org.jsimpledb.cli.cmd.InfoCommand

All Implemented Interfaces:: CliSession.Action, Command, Parser<CliSession.Action>

public class InfoCommand
extends AbstractCommand
implements CliSession.Action

Field Summary
- Fields inherited from class org.jsimpledb.cli.cmd.AbstractCommand
  log, name, paramParser

Constructor Summary

Constructors
Constructor and Description

InfoCommand()

Constructors
Constructor and Description
`InfoCommand()`

Method Summary

Methods
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 org.jsimpledb.cli.cmd.AbstractCommand
getHelpDetail, getName, getParser, getUsage, parse

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - InfoCommand
```
public InfoCommand()
```
- 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
  - 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
  - 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.JSIMPLEDB.
    
    Specified by:
    
    getSessionModes in interface Command
    
    Overrides:
    
    getSessionModes in class AbstractCommand
    
    Returns:
    set of supported SessionModes
  - 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

Class InfoCommand

Field Summary

Fields inherited from class org.jsimpledb.cli.cmd.AbstractCommand

Constructor Summary

Method Summary

Methods inherited from class org.jsimpledb.cli.cmd.AbstractCommand

Methods inherited from class java.lang.Object

Constructor Detail

InfoCommand

Method Detail

getHelpSummary

getAction

getSessionModes

run