com.smartfoxserver.v2.util

Enum ClientDisconnectionReason

java.lang.Object

java.lang.Enum<ClientDisconnectionReason>

com.smartfoxserver.v2.util.ClientDisconnectionReason

All Implemented Interfaces:

IDisconnectionReason, java.io.Serializable, java.lang.Comparable<ClientDisconnectionReason>

public enum ClientDisconnectionReason
extends java.lang.Enum<ClientDisconnectionReason>
implements IDisconnectionReason

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAN The client was banned
IDLE The client was disconnected because he was idle for longer than what configured in the Zone as the MaxUserIdleTime
KICK The client was kicked
UNKNOWN The reason was not detected

Method Summary

Modifier and Type	Method and Description
byte	getByteValue()
int	getValue()
static ClientDisconnectionReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClientDisconnectionReason[]	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

IDLE

public static final ClientDisconnectionReason IDLE

The client was disconnected because he was idle for longer than what configured in the Zone as the MaxUserIdleTime

KICK

public static final ClientDisconnectionReason KICK

The client was kicked

BAN

public static final ClientDisconnectionReason BAN

The client was banned

UNKNOWN

public static final ClientDisconnectionReason UNKNOWN

The reason was not detected

Method Detail

values

public static ClientDisconnectionReason[] 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 (ClientDisconnectionReason c : ClientDisconnectionReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientDisconnectionReason 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

getValue

public int getValue()

Specified by:

getValue in interface IDisconnectionReason

getByteValue

public byte getByteValue()

Specified by:

getByteValue in interface IDisconnectionReason