|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<OrderBookModelFilter>
com.dxfeed.model.market.OrderBookModelFilter
public enum OrderBookModelFilter
An order events filter for OrderBookModel
.
Filter specifies which order levels are allowed to be shown in the OrderBook.
Note that if more than one order level is allowed, events with higher level will hide
the ones with the lower level. E.g. aggregate order (Order.LEVEL_AGGREGATE
)
for the specified exchange and market-maker would disable regional order for that exchange
(Order.LEVEL_REGIONAL
which in turn would disable best bid and offer order (Order.LEVEL_COMPOSITE
).
Order.getLevel()
Enum Constant Summary | |
---|---|
AGGREGATE
Only AGGREGATE orders are enabled. |
|
ALL
All orders 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 | |
---|---|
boolean |
allowOrderLevel(int level)
Returns true if the specified Order level 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 |
---|
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
COMPOSITE
and REGIONAL
orders are enabled.
public static final OrderBookModelFilter COMPOSITE_REGIONAL_AGGREGATE
ORDER
orders are enabled.
public static final OrderBookModelFilter ALL
Method Detail |
---|
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 name
NullPointerException
- if the argument is nullpublic boolean allowOrderLevel(int level)
true
if the specified Order level is accepted, false
otherwise.
level
- Order level
true
if the specified Order level is accepted, false
otherwise.Order.getLevel()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |