com.dxfeed.model.market

Enum OrderBookModelFilter

java.lang.Object

java.lang.Enum<OrderBookModelFilter>

com.dxfeed.model.market.OrderBookModelFilter

All Implemented Interfaces:

Serializable, Comparable<OrderBookModelFilter>

public enum OrderBookModelFilter
extends Enum<OrderBookModelFilter>

An order events filter for OrderBookModel. Filter specifies which order scopes are allowed to be shown in the OrderBook.

Note that if more than one order scope is allowed, events with mode detailed scope will hide the ones with the less detailed scope. E.g. aggregate order (Scope.AGGREGATE) for the specified exchange and market-maker would disable regional order for that exchange (Scope.REGIONAL which in turn would disable best bid and offer order (Scope.COMPOSITE).

See Also:

Scope

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE Only AGGREGATE orders are enabled.
ALL All order scopes are enabled.
COMPOSITE Only COMPOSITE orders are enabled.
COMPOSITE_REGIONAL COMPOSITE and REGIONAL orders are enabled.
COMPOSITE_REGIONAL_AGGREGATE All orders except ORDER orders are enabled.
ORDER Only ORDER orders are enabled.
REGIONAL Only REGIONAL orders are enabled.

Method Summary

Modifier and Type	Method and Description
boolean	allowScope(Scope scope) Returns true if the specified order scope is accepted, false otherwise.
static OrderBookModelFilter	valueOf(String name) Returns the enum constant of this type with the specified name.
static OrderBookModelFilter[]	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 OrderBookModelFilter COMPOSITE

Only COMPOSITE orders are enabled.

REGIONAL

public static final OrderBookModelFilter REGIONAL

Only REGIONAL orders are enabled.

AGGREGATE

public static final OrderBookModelFilter AGGREGATE

Only AGGREGATE orders are enabled.

ORDER

public static final OrderBookModelFilter ORDER

Only ORDER orders are enabled.

COMPOSITE_REGIONAL

public static final OrderBookModelFilter COMPOSITE_REGIONAL

COMPOSITE and REGIONAL orders are enabled.

COMPOSITE_REGIONAL_AGGREGATE

public static final OrderBookModelFilter COMPOSITE_REGIONAL_AGGREGATE

All orders except ORDER orders are enabled.

ALL

public static final OrderBookModelFilter ALL

All order scopes are enabled.

Method Detail

values

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

Returns:

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

valueOf

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

allowScope

public boolean allowScope(Scope scope)

Returns true if the specified order scope is accepted, false otherwise.

Parameters:

scope - order scope

Returns:

true if the specified order scope is accepted, false otherwise.