Record Class PerpetualInstrument

java.lang.Object
java.lang.Record
com.wualabs.qtsurfer.engine.core.instrument.PerpetualInstrument
Record Components:
base - base currency, e.g. "BTC"
quote - quote currency, e.g. "USDT"
settle - settlement currency — an asset code, never a compound token
All Implemented Interfaces:
Instrument
public record PerpetualInstrument(@NonNull String base, @NonNull String quote, @NonNull String settle) extends Record implements Instrument
A perpetual contract — a derivative with no expiry: BTC/USDT:USDT when margined in the quote currency, BTC/USD:BTC when margined in the base.

Prefer Instrument.of(String, String, String) over this constructor. Neither accepts a null or blank component: a perpetual without a settlement currency is a spot pair, and the caller has to say which one it means.

  • Constructor Details

    • PerpetualInstrument

      public PerpetualInstrument(@NonNull @NonNull String base, @NonNull @NonNull String quote, @NonNull @NonNull String settle)
      Creates an instance of a PerpetualInstrument record class.
      Parameters:
      base - the value for the base record component
      quote - the value for the quote record component
      settle - the value for the settle record component

  • Method Details

    • isDerivative

      public boolean isDerivative()
      Description copied from interface: Instrument
      true for any contract settled in a currency — perpetual or dated.
      Specified by:
      isDerivative in interface Instrument

    • symbol

      public String symbol()
      Description copied from interface: Instrument
      CCXT-style canonical string. Inverse of Instrument.parse(String).
      Specified by:
      symbol in interface Instrument

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • base

      @NonNull public @NonNull String base()
      Returns the value of the base record component.
      Specified by:
      base in interface Instrument
      Returns:
      the value of the base record component

    • quote

      @NonNull public @NonNull String quote()
      Returns the value of the quote record component.
      Specified by:
      quote in interface Instrument
      Returns:
      the value of the quote record component

    • settle

      @NonNull public @NonNull String settle()
      Returns the value of the settle record component.
      Returns:
      the value of the settle record component