org.elastos.carrier.session

Enum StreamState

java.lang.Object

java.lang.Enum<StreamState>

org.elastos.carrier.session.StreamState

All Implemented Interfaces:

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

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

Carrier stream state The stream state will be changed according to the phase of the stream.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Closed The stream closed gracefully.
Connected The stream connected with remove peer.
Connecting The stream is trying to connect the remote.
Deactivated The stream is deactived.
Error The stream is on error, cannot to continue.
Initialized Initialized stream.
TransportReady The underlying transport is ready for the stream to start.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(StreamState state) Get description of carrier stream state.
java.lang.String	toString() Get description of current carrier stream state.
int	value() Get state value.
static StreamState	valueOf(int state) Get carrier stream state from state value.
static StreamState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StreamState[]	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

Initialized

public static final StreamState Initialized

Initialized stream.

TransportReady

public static final StreamState TransportReady

The underlying transport is ready for the stream to start.

Connecting

public static final StreamState Connecting

The stream is trying to connect the remote.

Connected

public static final StreamState Connected

The stream connected with remove peer.

Deactivated

public static final StreamState Deactivated

The stream is deactived.

Closed

public static final StreamState Closed

The stream closed gracefully.

Error

public static final StreamState Error

The stream is on error, cannot to continue.

Method Detail

values

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

Returns:

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

valueOf

public static StreamState 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 StreamState valueOf(int state)

Get carrier stream state from state value.

Parameters:

state - The state value.

Returns:

The carrier stream state.

Throws:

java.lang.IllegalArgumentException

value

public int value()

Get state value.

Returns:

The state value.

format

public static java.lang.String format(StreamState state)

Get description of carrier stream state.

Parameters:

state - The carrier stream state.

Returns:

The description of carrier stream state.

toString

public java.lang.String toString()

Get description of current carrier stream state.

Overrides:

toString in class java.lang.Enum<StreamState>

Returns:

The human readable description.