Package org.knowm.xchange.deribit.v2.dto.trade

Enum OrderFlags

java.lang.Object

java.lang.Enum<OrderFlags>

org.knowm.xchange.deribit.v2.dto.trade.OrderFlags

All Implemented Interfaces:

Serializable, Comparable<OrderFlags>, java.lang.constant.Constable, Order.IOrderFlags

public enum OrderFlags
extends Enum<OrderFlags>
implements Order.IOrderFlags

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MMP	Order MMP flag, only for order_type 'limit'
POST_ONLY	If true, the order is considered post-only.
REDUCE_ONLY	If true, the order is considered reduce-only which is intended to only reduce a current position
REJECT_POST_ONLY	If an order is considered post-only and this field is set to true then the order is put to order book unmodified or request is rejected and order is canceled.

Method Summary

Modifier and Type	Method	Description
static OrderFlags	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OrderFlags[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

POST_ONLY

public static final OrderFlags POST_ONLY

If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below the spread.

Only valid in combination with time_in_force="good_til_cancelled"

REJECT_POST_ONLY

public static final OrderFlags REJECT_POST_ONLY

If an order is considered post-only and this field is set to true then the order is put to order book unmodified or request is rejected and order is canceled.

Only valid in combination with "post_only" set to true

REDUCE_ONLY

public static final OrderFlags REDUCE_ONLY

If true, the order is considered reduce-only which is intended to only reduce a current position

MMP

public static final OrderFlags MMP

Order MMP flag, only for order_type 'limit'

Method Details

values

public static OrderFlags[] values()

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

Returns:

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

valueOf

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