com.dxfeed.ipf.live

Enum InstrumentProfileConnection.State

java.lang.Object

java.lang.Enum<InstrumentProfileConnection.State>

com.dxfeed.ipf.live.InstrumentProfileConnection.State

All Implemented Interfaces:

Serializable, Comparable<InstrumentProfileConnection.State>

Enclosing class:

InstrumentProfileConnection

public static enum InstrumentProfileConnection.State
extends Enum<InstrumentProfileConnection.State>

Instrument profile connection state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED Instrument profile connection was closed.
COMPLETED Initial instrument profiles snapshot was fully read (this state is set only once).
CONNECTED Connection was established.
CONNECTING Connection is being established.
NOT_CONNECTED Instrument profile connection is not started yet.

Method Summary

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

NOT_CONNECTED

public static final InstrumentProfileConnection.State NOT_CONNECTED

Instrument profile connection is not started yet. start was not invoked yet.

CONNECTING

public static final InstrumentProfileConnection.State CONNECTING

Connection is being established.

CONNECTED

public static final InstrumentProfileConnection.State CONNECTED

Connection was established.

COMPLETED

public static final InstrumentProfileConnection.State COMPLETED

Initial instrument profiles snapshot was fully read (this state is set only once).

CLOSED

public static final InstrumentProfileConnection.State CLOSED

Instrument profile connection was closed.

Method Detail

values

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

Returns:

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

valueOf

public static InstrumentProfileConnection.State valueOf(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:

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

NullPointerException - if the argument is null