com.trickl.model.oanda.pricing.common.Price Maven / Gradle / Ivy

Go to download
package com.trickl.model.oanda.pricing.common;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import java.math.BigDecimal;
import java.time.Instant;
import java.util.List;
import lombok.Builder;
import lombok.Data;
import lombok.Singular;

/** The Price representation. */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
    "instrument",
    "tradeable",
    "time",
    "baseBid",
    "baseAsk",
    "bids",
    "asks",
    "closeoutBid",
    "closeoutAsk"
})
@JsonIgnoreProperties({
    "status",
    "quoteHomeConversionFactors",
    "unitsAvailable"
})
@Data
@Builder
public class Price implements PriceStreamMessage {
  @JsonPropertyDescription("The type of the price message.")
  private final PriceStreamMessageType type = PriceStreamMessageType.PRICE;

  /** The Price's Instrument. */
  @JsonPropertyDescription("The Price's Instrument.")
  private String instrument;
 
  /** Flag indicating if the Price is tradeable or not. */
  @JsonPropertyDescription("Flag indicating if the Price is tradeable or not")
  private boolean tradeable;
 
  /** The date/time when the Price was created. */
  @JsonPropertyDescription("The date/time when the Price was created.")
  @JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss.nnnnnnnnnXXX", timezone = "UTC")
  private Instant time;
 
  /** The base bid price as calculated by pricing. */
  @JsonPropertyDescription("The base bid price as calculated by pricing.")
  private String baseBid;
 
  /** The base ask price as calculated by pricing. */
  @JsonPropertyDescription("The base ask price as calculated by pricing.")
  private String baseAsk;
 
  /**
   * The list of prices and liquidity available on the Instrument's bid side. It is possible for
   * this list to be empty if there is no bid liquidity currently available for the Instrument in
   * the Account.
   */
  @JsonPropertyDescription(
      "The list of prices and liquidity available on the Instrument's bid side. "
              + "It is possible for this list to be empty if there is no bid"
              + " liquidity currently available for the Instrument in the Account.")
  @Singular
  @JsonInclude(JsonInclude.Include.NON_EMPTY)
  private List bids;
  
  /**
   * The list of prices and liquidity available on the Instrument's ask side. It is possible for
   * this list to be empty if there is no ask liquidity currently available for the Instrument in
   * the Account.
   */
  @JsonPropertyDescription(
      "The list of prices and liquidity available on the Instrument's ask side."
              + " It is possible for this list to be empty if there is no ask"
              + " liquidity currently available for the Instrument in the Account.")
  @Singular
  @JsonInclude(JsonInclude.Include.NON_EMPTY)
  private List asks;
 
  /**
   * The closeout bid price. This price is used when a bid is required to closeout a Position
   * (margin closeout or manual) yet there is no bid liquidity. The closeout bid is never used to
   * open a new position.
   */
  @JsonPropertyDescription(
      "The closeout bid price. This price is used when a bid is required to closeout "
              + "a Position (margin closeout or manual) yet there is no bid liquidity."
              + " The closeout bid is never used to open a new position.")
  private BigDecimal closeoutBid;
  
  /**
   * The closeout ask price. This price is used when an ask is required to closeout a Position
   * (margin closeout or manual) yet there is no ask liquidity. The closeout ask is never used to
   * open a new position.
   */
  @JsonPropertyDescription(
      "The closeout ask price. This price is used when an ask is required to closeout"
              + " a Position (margin closeout or manual) yet there is no ask liquidity."
              + " The closeout ask is never used to open a new position.")
  private BigDecimal closeoutAsk;
}