io.github.nucleuspowered.nucleus.api.module.kit

Enum KitRedeemResult.Status

java.lang.Object

java.lang.Enum<KitRedeemResult.Status>

io.github.nucleuspowered.nucleus.api.module.kit.KitRedeemResult.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KitRedeemResult.Status>

Enclosing interface:

KitRedeemResult

public static enum KitRedeemResult.Status
extends java.lang.Enum<KitRedeemResult.Status>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_REDEEMED_ONE_TIME The one time kit has already been redeemed.
COOLDOWN_NOT_EXPIRED The cooldown has not expired.
NO_SPACE There is no space for the items in the kit.
PARTIAL_SUCCESS The redemption was a success, but some items were rejected
PRE_EVENT_CANCELLED The NucleusKitEvent.Redeem.Pre event was cancelled.
SUCCESS The redemption was a success, and everything was redeemed
UNKNOWN An unknown error occurred.

Method Summary

Modifier and Type	Method and Description
static KitRedeemResult.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KitRedeemResult.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final KitRedeemResult.Status SUCCESS

The redemption was a success, and everything was redeemed

PARTIAL_SUCCESS

public static final KitRedeemResult.Status PARTIAL_SUCCESS

The redemption was a success, but some items were rejected

ALREADY_REDEEMED_ONE_TIME

public static final KitRedeemResult.Status ALREADY_REDEEMED_ONE_TIME

The one time kit has already been redeemed.

COOLDOWN_NOT_EXPIRED

public static final KitRedeemResult.Status COOLDOWN_NOT_EXPIRED

The cooldown has not expired.

NO_SPACE

public static final KitRedeemResult.Status NO_SPACE

There is no space for the items in the kit.

PRE_EVENT_CANCELLED

public static final KitRedeemResult.Status PRE_EVENT_CANCELLED

The NucleusKitEvent.Redeem.Pre event was cancelled.

UNKNOWN

public static final KitRedeemResult.Status UNKNOWN

An unknown error occurred.

Method Detail

values

public static KitRedeemResult.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KitRedeemResult.Status c : KitRedeemResult.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KitRedeemResult.Status valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null