Source: xxe/control/CommandResult.js

  1. // Must be the ordinals of Java enum CommandResult.Status
  3. /**
  4.  * Command execution has succeeded.
  5.  * @type {number}
  6.  * @see CommandResult
  7.  */
  8. export const COMMAND_RESULT_DONE = 0;
  10. /**
  11.  * Command execution has been stopped because 
  12.  * this <em>remote command</em> is interactive. 
  13.  * @type {number}
  14.  * @see CommandResult
  15.  */
  16. export const COMMAND_RESULT_STOPPED = 1;
  18. /**
  19.  * Command execution was canceled by user.
  20.  * @type {number}
  21.  * @see CommandResult
  22.  */
  23. export const COMMAND_RESULT_CANCELED = 2;
  25. /**
  26.  * Command execution has failed.
  27.  * @type {number}
  28.  * @see CommandResult
  29.  */
  30. export const COMMAND_RESULT_FAILED = 3;
  32. /**
  33.  * Result object returned by {@link Command#execute}.
  34.  */
  35. export class CommandResult {
  36.     /**
  37.      * Constructor.
  38.      *
  39.      * @param status - status of the command execution
  40.      * @param [value=null] - result of the command execution
  41.      */
  42.     constructor(status, value=null) {
  43.         this._status = status;
  44.         this._value = value;
  45.     }
  46.     
  47.     /**
  48.      * Get the <code>status</code> property of this command result:
  49.      * the status of the command execution.
  50.      *
  51.      * @type {number}
  52.      * @see COMMAND_RESULT_DONE
  53.      * @see COMMAND_RESULT_STOPPED
  54.      * @see COMMAND_RESULT_CANCELED
  55.      * @see COMMAND_RESULT_FAILED
  56.      */
  57.     get status() {
  58.         return this._status;
  59.     }
  60.     
  61.     /**
  62.      * Get the <code>value</code> property of this command result:
  63.      * the result of the command execution. 
  64.      * May be <code>null</code>, which means: nothing useful.
  65.      *
  66.      * <p>How to interpret <code>value</code> depends on <code>status</code>:
  67.      * <dl>
  68.      * <dt><code>COMMAND_RESULT_DONE</code>
  69.      * <dd>The result value, a string, or <code>null</code>.
  70.      * <dt><code>COMMAND_RESULT_STOPPED</code> (<em>Remote command only.</em>)
  71.      * <dd><code>null</code> or a string which normally, after parsing it,
  72.      * should be displayed in a dialog box (e.g. a list of choices 
  73.      * letting the user specify what she/he wants).</dd>
  74.      * <dt><code>COMMAND_RESULT_CANCELED</code>
  75.      * <dd>Should be <code>null</code>.
  76.      * <dt><code>COMMAND_RESULT_FAILED</code>
  77.      * <dd>An error message or <code>null</code>.
  78.      * </dl>
  79.      * 
  80.      * @type {string}
  81.      */
  82.     get value() {
  83.         return this._value;
  84.     }
  86.     /**
  87.      * Returns a a string representing this result.
  88.      */
  89.     toString() {
  90.         let s = "CommandResult.";
  91.         switch (this._status) {
  92.         case COMMAND_RESULT_DONE:
  93.             s += "DONE";
  94.             break;
  95.         case COMMAND_RESULT_STOPPED:
  96.             s += "STOPPED";
  97.             break;
  98.         case COMMAND_RESULT_CANCELED:
  99.             s += "CANCELED";
  100.             break;
  101.         case COMMAND_RESULT_FAILED:
  102.             s += "FAILED";
  103.             break;
  104.         default:
  105.             s += "???";
  106.             break;
  107.         }
  108.         if (this._value !== null) {
  109.             s += '(' + this._value.toString() + ')';
  110.         }
  111.         
  112.         return s;
  113.     }
  115.     /**
  116.      * Convenience method: tests whether specified result is successful.
  117.      *
  118.      * @param {CommandResult} result - result to be tested; 
  119.      * may be <code>null</code> which is considered to be 
  120.      * a non-successful result.
  121.      */
  122.     static isDone(result) {
  123.         return (result !== null && result._status === COMMAND_RESULT_DONE);
  124.     }
  126.     /**
  127.      * Convenience method equivalent to returning
  128.      * <code>new CommandResult(COMMAND_RESULT_FAILED,value)</code>.
  129.      */
  130.     static failed(value) {
  131.         return new CommandResult(COMMAND_RESULT_FAILED, value);
  132.     }
  133.     
  134.     static deserialize(data) {
  135.         if (Array.isArray(data) && // null data OK.
  136.             data.length === 2 &&
  137.             Number.isInteger(data[0])) {
  138.             switch (data[0]) {
  139.             case COMMAND_RESULT_DONE:
  140.             case COMMAND_RESULT_STOPPED:
  141.             case COMMAND_RESULT_CANCELED:
  142.             case COMMAND_RESULT_FAILED:
  143.                 data = new CommandResult(data[0], data[1]);
  144.                 break;
  145.             }
  146.         }
  148.         return data;
  149.     }
  150.     
  151.     static formatCommandResult(cmd, result) {
  152.         return (result === null)?
  153.             `command\n"${cmd}"\ncould not be executed` :
  154.             `command\n"${cmd}"\nreturned\n${result}`;
  155.     }
  156. }
  157. CommandResult.DONE = new CommandResult(COMMAND_RESULT_DONE);
  158. CommandResult.STOPPED = new CommandResult(COMMAND_RESULT_STOPPED);
  159. CommandResult.CANCELED = new CommandResult(COMMAND_RESULT_CANCELED);
  160. CommandResult.FAILED = new CommandResult(COMMAND_RESULT_FAILED);