io.permazen.cli.cmd

Class EvalCommand.EvalAction

java.lang.Object

io.permazen.cli.cmd.EvalCommand.EvalAction

All Implemented Interfaces:

CliSession.Action, Session.HasTransactionOptions, Session.TransactionalAction

Enclosing class:

EvalCommand

public static final class EvalCommand.EvalAction
extends Object
implements CliSession.Action, Session.TransactionalAction, Session.HasTransactionOptions

Special transactional CliSession.Action used by the EvalCommand allowing access to the EvalException that occurred, if any.

This class is needed because EvalCommand catches and handles EvalExceptions thrown during expression evaluation itself, swallowing them, making it appear as if the command were always successful.

Method Summary

Modifier and Type	Method and Description
EvalException	getEvalException() Get the EvalException that occurred when evaluating the expression, if any.
Map<String,?>	getTransactionOptions() Get the options, if any, to be used when creating a new transaction for this action to run in.
void	run(CliSession session) Perform some action using the given CliSession while a transaction is open.

Methods inherited from class java.lang.Object

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

Method Detail

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

getTransactionOptions

public Map<String,?> getTransactionOptions()

Description copied from interface: Session.HasTransactionOptions

Get the options, if any, to be used when creating a new transaction for this action to run in.

Specified by:

getTransactionOptions in interface Session.HasTransactionOptions

Returns:

KVDatabase-specific transaction options, or null for none

getEvalException

public EvalException getEvalException()

Get the EvalException that occurred when evaluating the expression, if any.

Returns:

exception thrown during evaluation, or null if evaluation was successful