Package xyz.gmitch215.socketmc.util.option

Enum Class NarratorStatus

java.lang.Object

java.lang.Enum<NarratorStatus>

xyz.gmitch215.socketmc.util.option.NarratorStatus

All Implemented Interfaces:

Serializable, Comparable<NarratorStatus>, Constable

public enum NarratorStatus
extends Enum<NarratorStatus>

Represents the status of the narrator.

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
ALL	The narrator speaks on everything.
CHAT	The narrator speaks on chat messages.
OFF	The narrator is off.
SYSTEM	The narrator speaks on system messages.

Method Summary

Modifier and Type	Method	Description
static NarratorStatus	byOrdinal(int ordinal)	Gets the NarratorStatus by its ordinal.
static NarratorStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NarratorStatus[]	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

OFF

public static final NarratorStatus OFF

The narrator is off.

ALL

public static final NarratorStatus ALL

The narrator speaks on everything.

CHAT

public static final NarratorStatus CHAT

The narrator speaks on chat messages.

SYSTEM

public static final NarratorStatus SYSTEM

The narrator speaks on system messages.

Method Details

values

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

byOrdinal

public static NarratorStatus byOrdinal(int ordinal)

Gets the NarratorStatus by its ordinal.

Parameters:

ordinal - the ordinal

Returns:

NarratorStatus by ordinal