Enum Class OrderSide

java.lang.Object
java.lang.Enum<OrderSide>
markets.alpaca.client.openapi.broker.model.OrderSide
All Implemented Interfaces:
Serializable, Comparable<OrderSide>, Constable

public enum OrderSide extends Enum<OrderSide> implements Serializable
Represents what side of the transaction an order was on. Required for all order classes except for `mleg`.
  • Enum Constant Details

    • BUY

      public static final OrderSide BUY
    • SELL

      public static final OrderSide SELL
    • BUY_MINUS

      public static final OrderSide BUY_MINUS
    • SELL_PLUS

      public static final OrderSide SELL_PLUS
    • SELL_SHORT

      public static final OrderSide SELL_SHORT
    • SELL_SHORT_EXEMPT

      public static final OrderSide SELL_SHORT_EXEMPT
    • UNDISCLOSED

      public static final OrderSide UNDISCLOSED
    • CROSS

      public static final OrderSide CROSS
    • CROSS_SHORT

      public static final OrderSide CROSS_SHORT
  • Method Details

    • values

      public static OrderSide[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static OrderSide valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • getValue

      public String getValue()
    • toString

      public String toString()
      Overrides:
      toString in class Enum<OrderSide>
    • fromValue

      public static OrderSide fromValue(String value)
    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Throws:
      IOException