Enum Class PurchaseError

java.lang.Object
java.lang.Enum<PurchaseError>
com.csse3200.game.components.shop.PurchaseError
All Implemented Interfaces:
Serializable, Comparable<PurchaseError>, Constable

public enum PurchaseError extends Enum<PurchaseError>
Represents possible errors that can occur during a purchase event.

These values allow shop systems to communicate the exact reason why a purchase request failed, or NONE if successful.

  • Enum Constant Details

  • Method Details

    • values

      public static PurchaseError[] 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 PurchaseError 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
    • getCode

      public int getCode()
      Returns the code associated with a PurchaseError
      Returns:
      an integer representing the PurchaseError
    • fromCode

      public static PurchaseError fromCode(int code)
      Creates PurchaseError from a integer error code
      Parameters:
      code - The code representing the error.
      Returns:
      The PurchaseError.