Field Detail

• CLI_COMMANDS_DESCRIPTOR_RESOURCE

  public static final String CLI_COMMANDS_DESCRIPTOR_RESOURCE

  Classpath XML file resource describing available Commands: "META-INF/jsimpledb/cli-command-implementations.xml".

  Example:

    <cli-command-implementations>
        <cli-command-implementation class="com.example.MyCliCommand"/>
    </cli-command-implementations>
   

  Instances must have a public constructor taking either zero parameters or one CliSession parameter.

  See Also:

  loadCommandsFromClasspath(), Constant Field Values

Constructor Detail

• CliSession

  public CliSession(KVDatabase kvdb,
            PrintWriter writer,
            Console console)

  Constructor for SessionMode.KEY_VALUE mode.

  Parameters:

  kvdb - key/value database

  writer - CLI output

  console - associated console if any, otherwise null

  Throws:

  IllegalArgumentException - if kvdb or writer is null

• CliSession

  public CliSession(Database db,
            PrintWriter writer,
            Console console)

  Constructor for SessionMode.CORE_API mode.

  Parameters:

  db - core database

  writer - CLI output

  console - associated console if any, otherwise null

  Throws:

  IllegalArgumentException - if db or writer is null

• CliSession

  public CliSession(JSimpleDB jdb,
            PrintWriter writer,
            Console console)

  Constructor for SessionMode.JSIMPLEDB mode.

  Parameters:

  jdb - database

  writer - CLI output

  console - associated console if any, otherwise null

  Throws:

  IllegalArgumentException - if jdb or writer is null

Method Detail

• getConsole

  public Console getConsole()

  Get the associated Console, if any.

  Returns:

  associated Console, or null if there is no console associated with this instance

• getWriter

  public PrintWriter getWriter()

  Get the output PrintWriter for this CLI session.

  Returns:

  output writer

• getCommands

  public SortedMap<String,Command> getCommands()

  Get the Commands registered with this instance.

  Returns:

  registered commands indexed by name

• getLineLimit

  public int getLineLimit()

• setLineLimit

  public void setLineLimit(int lineLimit)

• isVerbose

  public boolean isVerbose()

• setVerbose

  public void setVerbose(boolean verbose)

• isDone

  public boolean isDone()

• setDone

  public void setDone(boolean done)

• loadCommandsFromClasspath

  public void loadCommandsFromClasspath()

  Scan the classpath for Commands and register them.

  See Also:

  CLI_COMMANDS_DESCRIPTOR_RESOURCE

• registerCommand

  public void registerCommand(Command command)

  Register the given Command.

  Any existing Command with the same name will be replaced.

  Parameters:

  command - new command

  Throws:

  IllegalArgumentException - if command is null

• reportException

  protected void reportException(Exception e)

  Overrides:

  reportException in class Session

• showStackTrace

  protected boolean showStackTrace(Exception e)

• getErrorMessagePrefix

  public String getErrorMessagePrefix()

  Get prefix for error messages.

  Default prefix is "Error: ".

  Returns:

  error message prefix

• setErrorMessagePrefix

  public void setErrorMessagePrefix(String prefix)

  Set prefix for error messages.

  Parameters:

  prefix - error message prefix

• performCliSessionAction

  public boolean performCliSessionAction(CliSession.Action action)

  Perform the given action in the context of this session.

  This is a CliSession-specific overload of Session.performSessionAction(); see that method for details.

  Parameters:

  action - action to perform, possibly within a transaction

  Returns:

  true if action completed successfully, false if a transaction could not be created or action threw an exception

  Throws:

  IllegalArgumentException - if action is null

• performCliSessionActionWithCurrentTransaction

  public boolean performCliSessionActionWithCurrentTransaction(CliSession.Action action)

  Associate the current JTransaction with this instance, if not already associated, while performing the given action.

  This is a CliSession-specific overload of Session.performSessionActionWithCurrentTransaction(); see that method for details.

  Parameters:

  action - action to perform

  Returns:

  true if action completed successfully, false if action threw an exception

  Throws:

  IllegalStateException - if there is a different open transaction already associated with this instance

  IllegalStateException - if this instance is not in mode SessionMode.JSIMPLEDB

  IllegalArgumentException - if action is null