com.caplin.streamlink

Enum CommandErrorType

java.lang.Object

java.lang.Enum<CommandErrorType>

com.caplin.streamlink.CommandErrorType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommandErrorType>

public enum CommandErrorType
extends java.lang.Enum<CommandErrorType>

Enumeration defining the errors that can occur for a command.

You can obtain the CommandErrorType by calling getError() on a CommandErrorEvent.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED Disconnect occurred and a command set as cancellable has been cancelled.
DELETED The subject has been deleted.
DISCONNECT_OCCURRED The command may have been sent to server, but disconnect occurred.
INVALID_PARAMETERS The supplied command parameters are invalid for the command.
NOT_FOUND The command subject could not be found.
READ_DENIED The client does not have permission to read the subject.
THROTTLE_FAILED The throttle command failed.
UNAVAILABLE The subject is not available.
WRITE_DENIED The client does not have permission to write to the subject.
WRITE_DENIED_TRADE_GROUP_LICENSE_EXCEEDED The Liberator has detected a breach of license conditions and has rejected the attempted trade.

Method Summary

Methods

Modifier and Type	Method and Description
static CommandErrorType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommandErrorType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DELETED

public static final CommandErrorType DELETED

The subject has been deleted.

DISCONNECT_OCCURRED

public static final CommandErrorType DISCONNECT_OCCURRED

The command may have been sent to server, but disconnect occurred. The command may not have been executed.

INVALID_PARAMETERS

public static final CommandErrorType INVALID_PARAMETERS

The supplied command parameters are invalid for the command.

NOT_FOUND

public static final CommandErrorType NOT_FOUND

The command subject could not be found.

READ_DENIED

public static final CommandErrorType READ_DENIED

The client does not have permission to read the subject.

THROTTLE_FAILED

public static final CommandErrorType THROTTLE_FAILED

The throttle command failed.

UNAVAILABLE

public static final CommandErrorType UNAVAILABLE

The subject is not available.

WRITE_DENIED

public static final CommandErrorType WRITE_DENIED

The client does not have permission to write to the subject.

WRITE_DENIED_TRADE_GROUP_LICENSE_EXCEEDED

public static final CommandErrorType WRITE_DENIED_TRADE_GROUP_LICENSE_EXCEEDED

The Liberator has detected a breach of license conditions and has rejected the attempted trade.

CANCELLED

public static final CommandErrorType CANCELLED

Disconnect occurred and a command set as cancellable has been cancelled.

Method Detail

values

public static CommandErrorType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommandErrorType c : CommandErrorType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommandErrorType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null