com.dxfeed.event.market

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

com.dxfeed.event.market.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>

public enum Scope
extends Enum<Scope>

Scope of an order.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE Represents aggregate information for a given price level or best bid or best offer for a given market maker.
COMPOSITE Represents best bid or best offer for the whole market.
ORDER Represents individual order on the market.
REGIONAL Represents best bid or best offer for a given exchange code.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns integer code that is used in flag bits.
static Scope	valueOf(int code) Returns scope by integer code bit pattern.
static Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static Scope[]	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

COMPOSITE

public static final Scope COMPOSITE

Represents best bid or best offer for the whole market.

REGIONAL

public static final Scope REGIONAL

Represents best bid or best offer for a given exchange code.

AGGREGATE

public static final Scope AGGREGATE

Represents aggregate information for a given price level or best bid or best offer for a given market maker.

ORDER

public static final Scope ORDER

Represents individual order on the market.

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static Scope valueOf(int code)

Returns scope by integer code bit pattern.

Parameters:

code - integer code.

Returns:

scope.

Throws:

ArrayIndexOutOfBoundsException - if code is invalid.

getCode

public int getCode()

Returns integer code that is used in flag bits.

Returns:

integer code.