Package org.knowm.xchange.coinbasepro.dto.trade

Enum CoinbaseProOrderFlags

java.lang.Object

java.lang.Enum<CoinbaseProOrderFlags>

org.knowm.xchange.coinbasepro.dto.trade.CoinbaseProOrderFlags

All Implemented Interfaces:

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

public enum CoinbaseProOrderFlags
extends Enum<CoinbaseProOrderFlags>
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
FILL_OR_KILL	A fill-or-kill order will either fill in its entirety or be completely aborted.
IMMEDIATE_OR_CANCEL	An immediate-or-cancel order can be partially or completely filled, but any portion of the order that cannot be filled immediately will be cancelled rather than left on the order book.
POST_ONLY	A post-only order will only be placed if no portion of it fills immediately; this guarantees you will never pay the taker fee on any part of the order that fills.

Method Summary

Modifier and Type	Method	Description
static CoinbaseProOrderFlags	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CoinbaseProOrderFlags[]	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

FILL_OR_KILL

public static final CoinbaseProOrderFlags FILL_OR_KILL

A fill-or-kill order will either fill in its entirety or be completely aborted.

IMMEDIATE_OR_CANCEL

public static final CoinbaseProOrderFlags IMMEDIATE_OR_CANCEL

An immediate-or-cancel order can be partially or completely filled, but any portion of the order that cannot be filled immediately will be cancelled rather than left on the order book.

POST_ONLY

public static final CoinbaseProOrderFlags POST_ONLY

A post-only order will only be placed if no portion of it fills immediately; this guarantees you will never pay the taker fee on any part of the order that fills.

Method Details

values

public static CoinbaseProOrderFlags[] 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 CoinbaseProOrderFlags 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