AbstractCommand (JSimpleDB CLI Classes 2.4.2 API)

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

All Implemented Interfaces:

Command, Parser<CliSession.Action>

Direct Known Subclasses:

AbstractKVCommand, CompareSchemasCommand, DeleteSchemaVersionCommand, EvalCommand, HelpCommand, ImportCommand, InfoCommand, KVSaveCommand, LoadCommand, QuitCommand, RegisterCommandCommand, RegisterFunctionCommand, SaveCommand, SetAllowNewSchemaCommand, SetHistoryFileCommand, SetSchemaVersionCommand, SetSessionModeCommand, SetValidationModeCommand, SetVerboseCommand, ShowAllSchemasCommand, ShowImportsCommand, ShowSchemaCommand, ShowVariablesCommand
```
public abstract class AbstractCommand
extends Object
implements Command
```
Support superclass for CLI Command implementations.

See Also:
Command

Field Summary

Fields
Modifier and Type Field and Description

protected Logger log

protected String name

protected ParamParser paramParser

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractCommand(String spec)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCommand(String spec)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract CliSession.Action`	`getAction(CliSession session, ParseContext ctx, boolean complete, 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.
`CliSession.Action`	`parse(ParseSession session, ParseContext ctx, boolean complete)`

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

- Field Detail
  - log
```
protected final Logger log
```
  - name
```
protected final String name
```
  - paramParser
```
protected final ParamParser paramParser
```
- Constructor Detail
  - AbstractCommand
```
protected AbstractCommand(String spec)
```
    Constructor.
    
    Parameters:
    spec - ParamParser spec string, possibly containing custom type names (see getParser())
- Method Detail
  - 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.JSIMPLEDB.
    
    Specified by:
    
    getSessionModes in interface Command
    
    Returns:
    set of supported SessionModes
  - parse
```
public CliSession.Action parse(ParseSession session,
                      ParseContext ctx,
                      boolean complete)
```
    The implementation in AbstractCommand parses the parameters and delegates to getAction() with the result.
    
    Specified by:
    
    parse in interface Parser<CliSession.Action>
    
    Parameters:
    session - CLI session
    ctx - input to parse
    complete - false if parse is "for real", true if only for tab completion calculation
    
    Returns:
    action to perform for the parsed command
    
    Throws:
    
    ParseException - if parse fails, or if complete is true and there are valid completions
    
    ParseException - if parameters are invalid
    
    IllegalArgumentException - if session is not a CliSession
  - getAction
```
protected abstract CliSession.Action getAction(CliSession session,
                          ParseContext ctx,
                          boolean complete,
                          Map<String,Object> params)
```
    Process command line parameters and return action.
    
    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
    
    Throws:
    
    ParseException - if parse fails, or if complete is true and there are valid completions
    
    ParseException - 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 FieldTypes registered with the database, type for an object type name (returns Integer), and objid for an object ID (returns ObjId).
    
    Parameters:
    typeName - parameter type name
    
    Returns:
    parser for parameters of the specified type

Class AbstractCommand

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

name

paramParser

Constructor Detail

AbstractCommand

Method Detail

getName

getUsage

getHelpSummary

getHelpDetail

getSessionModes

parse

getAction

getParser