Package dev.drawethree.xprison.api.gangs.enums

Enum Class GangLeaveReason

java.lang.Object

java.lang.Enum<GangLeaveReason>

dev.drawethree.xprison.api.gangs.enums.GangLeaveReason

All Implemented Interfaces:

Serializable, Comparable<GangLeaveReason>, Constable

public enum GangLeaveReason
extends Enum<GangLeaveReason>

Enum representing the reasons why a player leaves a gang.

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
ADMIN	Player removed from gang by console or command run by an admin.
KICK	Player was kicked out of the gang.
LEAVE	Player voluntarily left the gang.

Method Summary

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

ADMIN

public static final GangLeaveReason ADMIN

Player removed from gang by console or command run by an admin.

KICK

public static final GangLeaveReason KICK

Player was kicked out of the gang.

LEAVE

public static final GangLeaveReason LEAVE

Player voluntarily left the gang.

Method Details

values

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