io.github.nucleuspowered.nucleus.api.exceptions

Enum KitRedeemException.Reason

java.lang.Object

java.lang.Enum<KitRedeemException.Reason>

io.github.nucleuspowered.nucleus.api.exceptions.KitRedeemException.Reason

All Implemented Interfaces:

Serializable, Comparable<KitRedeemException.Reason>

Enclosing class:

KitRedeemException

public static enum KitRedeemException.Reason
extends Enum<KitRedeemException.Reason>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_REDEEMED 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.
PRE_EVENT_CANCELLED The NucleusKitEvent.Redeem.Pre was cancelled.
UNKNOWN An unknown error occurred.

Method Summary

Modifier and Type	Method and Description
static KitRedeemException.Reason	valueOf(String name) Returns the enum constant of this type with the specified name.
static KitRedeemException.Reason[]	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

ALREADY_REDEEMED

public static final KitRedeemException.Reason ALREADY_REDEEMED

The one time kit has already been redeemed.

COOLDOWN_NOT_EXPIRED

public static final KitRedeemException.Reason COOLDOWN_NOT_EXPIRED

The cooldown has not expired.

This indicates that the exception can be cast to KitRedeemException.Cooldown to get the amount of time left.

NO_SPACE

public static final KitRedeemException.Reason NO_SPACE

There is no space for the items in the kit.

PRE_EVENT_CANCELLED

public static final KitRedeemException.Reason PRE_EVENT_CANCELLED

The NucleusKitEvent.Redeem.Pre was cancelled.

This indicates that the exception can be cast to KitRedeemException.PreCancelled to get the amount of time left.

UNKNOWN

public static final KitRedeemException.Reason UNKNOWN

An unknown error occurred.

Method Detail

values

public static KitRedeemException.Reason[] 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 (KitRedeemException.Reason c : KitRedeemException.Reason.values())
    System.out.println(c);

Returns:

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

valueOf

public static KitRedeemException.Reason 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