Package com.ultikits.ultitools.websocket

Enum Class CloudPlayerLinks.Failure

java.lang.Object

java.lang.Enum<CloudPlayerLinks.Failure>

com.ultikits.ultitools.websocket.CloudPlayerLinks.Failure

All Implemented Interfaces:

Serializable, Comparable<CloudPlayerLinks.Failure>, java.lang.constant.Constable

Enclosing class:

CloudPlayerLinks

public static enum CloudPlayerLinks.Failure
extends Enum<CloudPlayerLinks.Failure>

Why a link request failed.

Since:

6.3.1

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
INTERNAL_ERROR	The gateway answered with an unexpected error.
LINK_NOT_PERMITTED	The gateway refuses to issue links: server suspended, links disabled, or identity banned.
NOT_CONNECTED	This server holds no usable UltiCloud connection; no request was sent.
RATE_LIMITED	The gateway rate-limited the request; a later attempt may succeed.
TIMED_OUT	The gateway did not answer within 30 seconds.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Failure()

Method Summary

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

NOT_CONNECTED

public static final CloudPlayerLinks.Failure NOT_CONNECTED

This server holds no usable UltiCloud connection; no request was sent.

RATE_LIMITED

public static final CloudPlayerLinks.Failure RATE_LIMITED

The gateway rate-limited the request; a later attempt may succeed.

LINK_NOT_PERMITTED

public static final CloudPlayerLinks.Failure LINK_NOT_PERMITTED

The gateway refuses to issue links: server suspended, links disabled, or identity banned.

TIMED_OUT

public static final CloudPlayerLinks.Failure TIMED_OUT

The gateway did not answer within 30 seconds.

INTERNAL_ERROR

public static final CloudPlayerLinks.Failure INTERNAL_ERROR

The gateway answered with an unexpected error.

Constructor Details

Failure

private Failure()

Method Details

values

public static CloudPlayerLinks.Failure[] 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 CloudPlayerLinks.Failure 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