Enum GeminiOrderFlags

java.lang.Object
java.lang.Enum<GeminiOrderFlags>
org.knowm.xchange.gemini.v1.dto.trade.GeminiOrderFlags
All Implemented Interfaces:
Serializable, Comparable<GeminiOrderFlags>, java.lang.constant.Constable, Order.IOrderFlags

public enum GeminiOrderFlags
extends Enum<GeminiOrderFlags>
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
    AUCTION_ONLY
    This order will be added to the auction-only book for the next auction for this symbol.
    FILL_OR_KILL
    This order will only remove liquidity from the order book.
    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.
    INDICATION_OF_INTEREST
    An Indication of Interest (IOI) represents a request for liquidity from block trading market-makers for this symbol.
    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 GeminiOrderFlags valueOf​(String name)
    Returns the enum constant of this type with the specified name.
    static GeminiOrderFlags[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • IMMEDIATE_OR_CANCEL

      public static final GeminiOrderFlags 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 GeminiOrderFlags 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.
    • FILL_OR_KILL

      public static final GeminiOrderFlags FILL_OR_KILL
      This order will only remove liquidity from the order book.

      It will fill the entire order immediately or cancel.

      If the order doesn't fully fill immediately, the response back from the API will indicate that the order has already been canceled ("is_cancelled": true in JSON).

    • AUCTION_ONLY

      public static final GeminiOrderFlags AUCTION_ONLY
      This order will be added to the auction-only book for the next auction for this symbol. The order may be cancelled up until the the auction locks, after which cancel requests will be rejected
    • INDICATION_OF_INTEREST

      public static final GeminiOrderFlags INDICATION_OF_INTEREST
      An Indication of Interest (IOI) represents a request for liquidity from block trading market-makers for this symbol.
  • Method Details

    • values

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