Package org.knowm.xchange.poloniex.dto.trade

Enum PoloniexOrderFlags

java.lang.Object

java.lang.Enum<PoloniexOrderFlags>

org.knowm.xchange.poloniex.dto.trade.PoloniexOrderFlags

All Implemented Interfaces:

Serializable, Comparable<PoloniexOrderFlags>, Order.IOrderFlags

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

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.
MARGIN	A margin trade whos capital is provided by borrow a given % of the notional value.
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 PoloniexOrderFlags	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PoloniexOrderFlags[]	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

FILL_OR_KILL

public static final PoloniexOrderFlags FILL_OR_KILL

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

IMMEDIATE_OR_CANCEL

public static final PoloniexOrderFlags 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 PoloniexOrderFlags 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.

MARGIN

public static final PoloniexOrderFlags MARGIN

A margin trade whos capital is provided by borrow a given % of the notional value.

Method Detail

values

public static PoloniexOrderFlags[] 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 (PoloniexOrderFlags c : PoloniexOrderFlags.values())
    System.out.println(c);

Returns:

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

valueOf

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