Package dev.drawethree.xprison.api.shared.currency.enums

Enum Class ReceiveCause

java.lang.Object

java.lang.Enum<ReceiveCause>

dev.drawethree.xprison.api.shared.currency.enums.ReceiveCause

All Implemented Interfaces:

Serializable, Comparable<ReceiveCause>, Constable

public enum ReceiveCause
extends Enum<ReceiveCause>

Enum representing various causes for a player receiving Gems or Tokens.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GIVE	Player received currency by the give command.
LUCKY_BLOCK	Player received currency by breaking lucky blocks.
MINING	Player received currency by mining (their own mining).
MINING_OTHERS	Player received currency by mining from other players.
PAY	Player received currency by using the pay command.
REDEEM	Player received currency by redeeming items.
REFUND	Player received currency by disenchanting items (refund).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MINING

public static final ReceiveCause MINING

Player received currency by mining (their own mining).

PAY

public static final ReceiveCause PAY

Player received currency by using the pay command.

GIVE

public static final ReceiveCause GIVE

Player received currency by the give command.

REDEEM

public static final ReceiveCause REDEEM

Player received currency by redeeming items.

LUCKY_BLOCK

public static final ReceiveCause LUCKY_BLOCK

Player received currency by breaking lucky blocks.

REFUND

public static final ReceiveCause REFUND

Player received currency by disenchanting items (refund).

MINING_OTHERS

public static final ReceiveCause MINING_OTHERS

Player received currency by mining from other players.

Method Details

values

public static ReceiveCause[] 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 ReceiveCause 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