Package me.fami6xx.rpuniverse.core.misc

Enum Class PlayerMode

java.lang.Object

java.lang.Enum<PlayerMode>

me.fami6xx.rpuniverse.core.misc.PlayerMode

All Implemented Interfaces:

Serializable, Comparable<PlayerMode>, Constable

public enum PlayerMode
extends Enum<PlayerMode>

The PlayerMode enum is used to determine the mode of the player

Version:

1.0

Author:

Fami6xx

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
MODERATOR
USER

Method Summary

Modifier and Type	Method	Description
String	getMode()	Get the string of the PlayerMode
static PlayerMode	getModeFromString(String mode)	Get the PlayerMode from a string
static PlayerMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerMode[]	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

USER

public static final PlayerMode USER

MODERATOR

public static final PlayerMode MODERATOR

ADMIN

public static final PlayerMode ADMIN

Method Details

values

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

getMode

public String getMode()

Get the string of the PlayerMode

Returns:

The string of the PlayerMode

getModeFromString

public static PlayerMode getModeFromString(String mode)

Get the PlayerMode from a string

Parameters:

mode - The string to get the PlayerMode from

Returns:

The PlayerMode if found, null otherwise