com.dxfeed.model.market
Enum OrderBookModelFilter

java.lang.Object
  extended by java.lang.Enum<OrderBookModelFilter>
      extended by 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 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).

See Also:
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

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 orders 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

allowOrderLevel

public boolean allowOrderLevel(int level)
Returns true if the specified Order level is accepted, false otherwise.

Parameters:
level - Order level
Returns:
true if the specified Order level is accepted, false otherwise.
See Also:
Order.getLevel()


Copyright © 2013 Devexperts. All Rights Reserved.