net.quedex.api.market

Class Instrument

java.lang.Object

net.quedex.api.market.Instrument

public final class Instrument
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instrument.OptionType
static class	Instrument.Type

Field Summary

Fields

Modifier and Type	Field and Description
static int	SETTLEMENT_HOUR_UTC_MILLIS

Constructor Summary

Constructors

Constructor and Description

Instrument(java.lang.String symbol, int instrumentId, Instrument.Type type, Instrument.OptionType optionType, java.math.BigDecimal tickSize, long issueDate, long expirationDate, java.lang.String underlyingSymbol, int notionalAmount, java.math.BigDecimal feeFraction, java.math.BigDecimal takerToMakerFraction, java.math.BigDecimal initialMarginFraction, java.math.BigDecimal maintenanceMarginFraction, java.math.BigDecimal strike)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
long	getExpirationDate()
java.math.BigDecimal	getFeeFraction()
java.math.BigDecimal	getInitialMarginFraction()
int	getInstrumentId()
long	getIssueDate()
java.math.BigDecimal	getMaintenanceMarginFraction()
java.math.BigDecimal	getMakerFeeFraction()
int	getNotionalAmount()
Instrument.OptionType	getOptionType()
java.math.BigDecimal	getStrike()
java.lang.String	getSymbol()
java.math.BigDecimal	getTakerFeeFraction()
java.math.BigDecimal	getTakerToMakerFeeFraction()
java.math.BigDecimal	getTickSize()
Instrument.Type	getType()
java.lang.String	getUnderlyingSymbol()
int	hashCode()
boolean	isFutures()
boolean	isTraded(long currentTimeMillis)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SETTLEMENT_HOUR_UTC_MILLIS

public static final int SETTLEMENT_HOUR_UTC_MILLIS

See Also:

Constant Field Values

Constructor Detail

Instrument

public Instrument(java.lang.String symbol,
                  int instrumentId,
                  Instrument.Type type,
                  Instrument.OptionType optionType,
                  java.math.BigDecimal tickSize,
                  long issueDate,
                  long expirationDate,
                  java.lang.String underlyingSymbol,
                  int notionalAmount,
                  java.math.BigDecimal feeFraction,
                  java.math.BigDecimal takerToMakerFraction,
                  java.math.BigDecimal initialMarginFraction,
                  java.math.BigDecimal maintenanceMarginFraction,
                  java.math.BigDecimal strike)

Method Detail

getSymbol

public java.lang.String getSymbol()

getInstrumentId

public int getInstrumentId()

getType

public Instrument.Type getType()

getTickSize

public java.math.BigDecimal getTickSize()

getIssueDate

public long getIssueDate()

getExpirationDate

public long getExpirationDate()

getUnderlyingSymbol

public java.lang.String getUnderlyingSymbol()

getNotionalAmount

public int getNotionalAmount()

getFeeFraction

public java.math.BigDecimal getFeeFraction()

getTakerToMakerFeeFraction

public java.math.BigDecimal getTakerToMakerFeeFraction()

getTakerFeeFraction

public java.math.BigDecimal getTakerFeeFraction()

Returns:

taker fee fraction

getMakerFeeFraction

public java.math.BigDecimal getMakerFeeFraction()

Returns:

maker fee fraction (may be negative)

getInitialMarginFraction

public java.math.BigDecimal getInitialMarginFraction()

getMaintenanceMarginFraction

public java.math.BigDecimal getMaintenanceMarginFraction()

getStrike

public java.math.BigDecimal getStrike()

Returns:

strike value if the instrument is option, null otherwise

getOptionType

public Instrument.OptionType getOptionType()

Returns:

type of the option if the instrument is option, null otherwise

isFutures

public boolean isFutures()

isTraded

public boolean isTraded(long currentTimeMillis)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object