public enum OrderBookModelFilter extends Enum<OrderBookModelFilter>
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
).
Scope
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_REGIONAL_AGGREGATE
All orders except
ORDER orders are enabled. |
ORDER
Only
ORDER orders are enabled. |
REGIONAL
Only
REGIONAL orders are enabled. |
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.
|
public static final OrderBookModelFilter COMPOSITE
COMPOSITE
orders are enabled.public static final OrderBookModelFilter REGIONAL
REGIONAL
orders are enabled.public static final OrderBookModelFilter AGGREGATE
AGGREGATE
orders are enabled.public static final OrderBookModelFilter ORDER
ORDER
orders are enabled.public static final OrderBookModelFilter COMPOSITE_REGIONAL
public static final OrderBookModelFilter COMPOSITE_REGIONAL_AGGREGATE
ORDER
orders are enabled.public static final OrderBookModelFilter ALL
public static OrderBookModelFilter[] values()
for (OrderBookModelFilter c : OrderBookModelFilter.values()) System.out.println(c);
public static OrderBookModelFilter valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic boolean allowScope(Scope scope)
true
if the specified order scope is accepted, false
otherwise.scope
- order scopetrue
if the specified order scope is accepted, false
otherwise.Copyright © 2002–2022 Devexperts LLC. All rights reserved.