Enum Class EndChangeCause

java.lang.Object

java.lang.Enum<EndChangeCause>

net.mathias2246.buildmc.api.endEvent.EndChangeCause

All Implemented Interfaces:

Serializable, Comparable<EndChangeCause>, Constable

public enum EndChangeCause
extends Enum<EndChangeCause>

Represents the reason why the End is being opened or closed.

Used in EndStateChangeEvent and EndManager and other End-related places to provide context to listeners.

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
COMMAND	The End is being opened or closed due to a player or admin command.
OTHER	The End is being opened or closed for any other reason not covered by COMMAND or PLUGIN.
PLUGIN	The End is being opened or closed programmatically by another plugin.

Method Summary

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

COMMAND

public static final EndChangeCause COMMAND

The End is being opened or closed due to a player or admin command.

PLUGIN

public static final EndChangeCause PLUGIN

The End is being opened or closed programmatically by another plugin.

OTHER

public static final EndChangeCause OTHER

The End is being opened or closed for any other reason not covered by COMMAND or PLUGIN.

Method Details

values

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