Enum AuctionResponse

java.lang.Object
java.lang.Enum<AuctionResponse>
com.olziedev.playerauctions.api.auction.AuctionResponse
All Implemented Interfaces:
Serializable, Comparable<AuctionResponse>, java.lang.constant.Constable

public enum AuctionResponse extends Enum<AuctionResponse>
List of all possible responses for some auction callbacks.
  • Enum Constant Details

    • SUCCESS

      public static final AuctionResponse SUCCESS
      This constant is used when the action was successful. (Nothing stopped the action from happening)
    • CANCELLED

      public static final AuctionResponse CANCELLED
      This constant is used when the action wasn't successful. (Something stopped the action from happening)
  • Method Details

    • values

      public static AuctionResponse[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static AuctionResponse valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null
    • setMessage

      public AuctionResponse setMessage(String message)
      Modifies the message for the enum instance.
      Parameters:
      message - The message for the player to receive
      Returns:
      The enum instance.
    • getMessage

      public String getMessage()
      Returns:
      The message that was stored in the enum instance, it then resets back to null for any future messages.
    • isSuccessful

      public boolean isSuccessful()
      Returns:
      If the action was successful or not.