org.elastos.carrier.session

Enum CloseReason

java.lang.Object

java.lang.Enum<CloseReason>

org.elastos.carrier.session.CloseReason

All Implemented Interfaces:

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

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

Multiplexing channel close reason mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Error Channel closed because error occured.
Normal Channel closed normaly.
Timeout Channel closed because of timeout.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(CloseReason reason) Get the fully formatized string of close reason instance.
java.lang.String	toString() Get fully formatized string.
int	value() Get reason value.
static CloseReason	valueOf(int reason) Get CloseReason instance from reason value.
static CloseReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CloseReason[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Normal

public static final CloseReason Normal

Channel closed normaly.

Timeout

public static final CloseReason Timeout

Channel closed because of timeout.

Error

public static final CloseReason Error

Channel closed because error occured.

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static CloseReason valueOf(int reason)

Get CloseReason instance from reason value.

Parameters:

reason - The value of reason mode.

Returns:

The close reason instance.

Throws:

java.lang.IllegalArgumentException

value

public int value()

Get reason value.

Returns:

The reason value.

format

public static java.lang.String format(CloseReason reason)

Get the fully formatized string of close reason instance.

Parameters:

reason - The close reason instance.

Returns:

The formatized string of close reason.

toString

public java.lang.String toString()

Get fully formatized string.

Overrides:

toString in class java.lang.Enum<CloseReason>

Returns:

The fully formatized string.