Package com.ohacd.matchbox.api

Enum Class SessionCreationResult.ErrorType

java.lang.Object

java.lang.Enum<SessionCreationResult.ErrorType>

com.ohacd.matchbox.api.SessionCreationResult.ErrorType

All Implemented Interfaces:

Serializable, Comparable<SessionCreationResult.ErrorType>, Constable

Enclosing class:

SessionCreationResult

public static enum SessionCreationResult.ErrorType
extends Enum<SessionCreationResult.ErrorType>

Enumeration of possible error types during session creation.

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
GAME_MANAGER_NOT_AVAILABLE	Game manager is not available
INTERNAL_ERROR	Internal error during session creation
INVALID_DISCUSSION_LOCATION	Discussion location is invalid
NO_PLAYERS	No valid players were provided
NO_SPAWN_POINTS	No valid spawn points were provided
PLUGIN_NOT_AVAILABLE	The plugin instance is not available
SESSION_EXISTS	A session with the given name already exists
SESSION_MANAGER_NOT_AVAILABLE	Session manager is not available

Method Summary

Modifier and Type	Method	Description
String	getDefaultMessage()	Gets the default human-readable message associated with this error type.
static SessionCreationResult.ErrorType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SessionCreationResult.ErrorType[]	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

NO_PLAYERS

public static final SessionCreationResult.ErrorType NO_PLAYERS

No valid players were provided

NO_SPAWN_POINTS

public static final SessionCreationResult.ErrorType NO_SPAWN_POINTS

No valid spawn points were provided

SESSION_EXISTS

public static final SessionCreationResult.ErrorType SESSION_EXISTS

A session with the given name already exists

PLUGIN_NOT_AVAILABLE

public static final SessionCreationResult.ErrorType PLUGIN_NOT_AVAILABLE

The plugin instance is not available

SESSION_MANAGER_NOT_AVAILABLE

public static final SessionCreationResult.ErrorType SESSION_MANAGER_NOT_AVAILABLE

Session manager is not available

GAME_MANAGER_NOT_AVAILABLE

public static final SessionCreationResult.ErrorType GAME_MANAGER_NOT_AVAILABLE

Game manager is not available

INVALID_DISCUSSION_LOCATION

public static final SessionCreationResult.ErrorType INVALID_DISCUSSION_LOCATION

Discussion location is invalid

INTERNAL_ERROR

public static final SessionCreationResult.ErrorType INTERNAL_ERROR

Internal error during session creation

Method Details

values

public static SessionCreationResult.ErrorType[] 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 SessionCreationResult.ErrorType 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

getDefaultMessage

public String getDefaultMessage()

Gets the default human-readable message associated with this error type.

Returns:

default error message suitable for logging or display