Enum Class OperationProgress.State

java.lang.Object
java.lang.Enum<OperationProgress.State>
dev.despical.mazeengine.api.operation.OperationProgress.State
All Implemented Interfaces:
Serializable, Comparable<OperationProgress.State>, Constable
Enclosing class:
OperationProgress
public static enum OperationProgress.State extends Enum<OperationProgress.State>
Describes whether an operation is active or has reached a final outcome.

Terminal states remain attached to the original handle after later work uses the same maze identifier. Failure and cancellation do not imply rollback.

  • Enum Constant Details

    • RUNNING

      public static final OperationProgress.State RUNNING
      The accepted operation has not reached a final outcome.

      This includes topology planning, preparation, world work, and waiting for required persistence; blocks need not be changing at every moment.

    • COMPLETED

      public static final OperationProgress.State COMPLETED
      The requested operation and its final persistence finished successfully.

      The completion stage contains an OperationResult and the reservation has been released. This state does not imply that the actor was teleported.

    • FAILED

      public static final OperationProgress.State FAILED
      The operation ended with an error other than cancellation.

      The completion stage is exceptional. Blocks may already have changed, so a retained failed record may need repair, regeneration, or removal.

    • CANCELLED

      public static final OperationProgress.State CANCELLED
      The operation ended because it was cancelled or the plugin stopped.

      The completion stage uses CancellationException. World changes already applied are not guaranteed to have been undone.

  • Method Details

    • values

      public static OperationProgress.State[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OperationProgress.State valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null