Package tkrzw

Class Status

Object
Status
public class Status extends Object
Status of operations

  • Field Details

    • SUCCESS

      public static final Status.Code SUCCESS
      Status code: Success.

    • UNKNOWN_ERROR

      public static final Status.Code UNKNOWN_ERROR
      Status code: Generic error whose cause is unknown.

    • SYSTEM_ERROR

      public static final Status.Code SYSTEM_ERROR
      Status code: Generic error from underlying systems.

    • NOT_IMPLEMENTED_ERROR

      public static final Status.Code NOT_IMPLEMENTED_ERROR
      Status code: Error that the feature is not implemented.

    • PRECONDITION_ERROR

      public static final Status.Code PRECONDITION_ERROR
      Status code: Error that a precondition is not met.

    • INVALID_ARGUMENT_ERROR

      public static final Status.Code INVALID_ARGUMENT_ERROR
      Status code: Error that a given argument is invalid.

    • CANCELED_ERROR

      public static final Status.Code CANCELED_ERROR
      Status code: Error that the operation is canceled.

    • NOT_FOUND_ERROR

      public static final Status.Code NOT_FOUND_ERROR
      Status code: Error that a specific resource is not found.

    • PERMISSION_ERROR

      public static final Status.Code PERMISSION_ERROR
      Status code: Error that the operation is not permitted.

    • INFEASIBLE_ERROR

      public static final Status.Code INFEASIBLE_ERROR
      Status code: Error that the operation is infeasible.

    • DUPLICATION_ERROR

      public static final Status.Code DUPLICATION_ERROR
      Status code: Error that a specific resource is duplicated.

    • BROKEN_DATA_ERROR

      public static final Status.Code BROKEN_DATA_ERROR
      Status code: Error that internal data are broken.

    • NETWORK_ERROR

      public static final Status.Code NETWORK_ERROR
      Status code: Error caused by networking failure.

    • APPLICATION_ERROR

      public static final Status.Code APPLICATION_ERROR
      Status code: Generic error caused by the application logic.

  • Constructor Details

    • Status

      public Status()
      Constructor representing the success code.

    • Status

      public Status(Status.Code code)
      Constructor representing a specific status code.
      Parameters:
      code - The status code.

    • Status

      public Status(Status.Code code, String message)
      Constructor representing a specific status.
      Parameters:
      code - The status code.
      message - An arbitrary status message.

  • Method Details

    • getCode

      public Status.Code getCode()
      Gets the status code.
      Returns:
      The status code.

    • getMessage

      public String getMessage()
      Gets the status message.
      Returns:
      The status message.

    • set

      public void set(Status.Code code, String message)
      Sets the code and the message.
      Parameters:
      code - The status code.
      message - An arbitrary status message.

    • join

      public void join(Status rhs)
      Assigns the internal state from another status object only if the current state is success.
      Parameters:
      rhs - The status object.

    • toString

      public String toString()
      Gets the string expression.
      Overrides:
      toString in class Object
      Returns:
      The string expression.

    • equals

      public boolean equals(Status rhs)
      Checks equality.
      Parameters:
      rhs - a status object.
      Returns:
      True for the both operands are equal, or false if not.

    • equals

      public boolean equals(Status.Code rhs)
      Checks equality.
      Parameters:
      rhs - a status code.
      Returns:
      True for the both operands are equal, or false if not.

    • clone

      public Status clone()
      Clones the object.
      Overrides:
      clone in class Object
      Returns:
      The clone object.

    • isOK

      public boolean isOK()
      Returns true if the status is success.
      Returns:
      True if the status is success, or false if not.

    • orDie

      public void orDie()
      Throws an exception if the status is not success.
      Throws:
      StatusException - The exception object containing the status.