Package com.pnfsoftware.jeb.util.interpreter

Class ExecutionResult

java.lang.Object
com.pnfsoftware.jeb.util.interpreter.ExecutionResult
public class ExecutionResult extends Object
An object representing the result of execution of an action, including a type integer (return code) and a message string.

  • Field Details

    • CODE_SUCCESS

      public static final int CODE_SUCCESS
      Success result code.
      See Also:

    • CODE_ERROR

      public static final int CODE_ERROR
      Generic error result code.
      See Also:

    • CODE_NOT_SUPPORTED

      public static final int CODE_NOT_SUPPORTED
      Unsupported operation result code.
      See Also:

    • CODE_NOT_IMPLEMENTED

      public static final int CODE_NOT_IMPLEMENTED
      Not-implemented operation result code.
      See Also:

    • GENERIC_SUCCESS

      public static final ExecutionResult GENERIC_SUCCESS
      Generic successful execution result.

    • GENERIC_ERROR

      public static final ExecutionResult GENERIC_ERROR
      Generic failed execution result.

    • NOT_SUPPORTED

      public static final ExecutionResult NOT_SUPPORTED
      Generic unsupported-operation execution result.

    • NOT_IMPLEMENTED

      public static final ExecutionResult NOT_IMPLEMENTED
      Generic not-implemented execution result.

  • Method Details

    • success

      public static ExecutionResult success(String msg)
      Create a successful execution result.
      Parameters:
      msg - result message
      Returns:
      a successful execution result

    • error

      public static ExecutionResult error(String msg)
      Create an error execution result.
      Parameters:
      msg - error message
      Returns:
      an error execution result

    • error

      public static ExecutionResult error(Throwable e)
      Create an error execution result from an exception.
      Parameters:
      e - exception to convert
      Returns:
      an error execution result

    • failure

      public static ExecutionResult failure(String msg)
      Create an error execution result.
      Parameters:
      msg - error message
      Returns:
      an error execution result

    • fromBoolean

      public static ExecutionResult fromBoolean(boolean success)
      Convert a boolean to a generic execution result.
      Parameters:
      success - true for success, false for error
      Returns:
      GENERIC_SUCCESS or GENERIC_ERROR

    • fromObject

      public static ExecutionResult fromObject(Object object)
      Convert an object to an execution result.
      Parameters:
      object - object to convert
      Returns:
      a successful result containing object.toString(), or GENERIC_ERROR if the object is null

    • getCode

      public int getCode()
      Get the result code.
      Returns:
      result code

    • isSuccess

      public boolean isSuccess()
      Determine whether execution succeeded.
      Returns:
      true if the result code is CODE_SUCCESS

    • isError

      public boolean isError()
      Determine whether execution failed.
      Returns:
      true if the result code is not CODE_SUCCESS

    • getMessage

      public String getMessage()
      Get the result message.
      Returns:
      result message, never null

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object