com.marketfactory.mfclient.internal.core.marketdata

Class ReusableSecurityDefinition

java.lang.Object

com.marketfactory.mfclient.internal.core.marketdata.ReusableSecurityDefinition

All Implemented Interfaces:

SecurityDefinition

public final class ReusableSecurityDefinition
extends java.lang.Object
implements SecurityDefinition

Field Summary

Fields inherited from interface com.marketfactory.mfclient.api.core.marketdata.SecurityDefinition

BIG_PRICE_INCREMENT_NULL_VALUE, MIN_PRICE_INCREMENT_NULL_VALUE, SECURITY_ID_NULL_VALUE, SYMBOL_MAX_BYTE_COUNT, VENUE_ID_NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
ReusableSecurityDefinition()

Method Summary

Modifier and Type	Method and Description
double	getBigPriceIncrement() The location of the big figure for this price as a decimal - 0.001 for example.
long	getBigPriceIncrementAsMantissa() The location of the big figure for this price.
double	getMinPriceIncrement() The granularity of prices for this security (on this venue).
long	getMinPriceIncrementAsMantissa() The granularity of prices for this security (on this venue).
long	getSecurityID()
java.lang.String	getSymbol() The security symbol (i.e.
void	getSymbol(byte[] symbol) The security symbol (i.e.
long	getTotNumReports() The total number of SecurityDefinitions to expect in the group from the same SecurityDefinitionRequest.
long	getVenueID()
ReusableSecurityDefinition	setDecoder(mfmarketdata.SecurityDefinitionDecoder decoder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReusableSecurityDefinition

public ReusableSecurityDefinition()

Method Detail

setDecoder

public ReusableSecurityDefinition setDecoder(mfmarketdata.SecurityDefinitionDecoder decoder)

getVenueID

public long getVenueID()

Specified by:

getVenueID in interface SecurityDefinition

getSecurityID

public long getSecurityID()

Specified by:

getSecurityID in interface SecurityDefinition

getTotNumReports

public long getTotNumReports()

Description copied from interface: SecurityDefinition

The total number of SecurityDefinitions to expect in the group from the same SecurityDefinitionRequest. This is used to verify that you have received all of the SecurityDefinitions.

Specified by:

getTotNumReports in interface SecurityDefinition

getSymbol

public void getSymbol(byte[] symbol)

Description copied from interface: SecurityDefinition

The security symbol (i.e. EURUSD). To retrieve the UTF-8 bytes, provide a properly sized byte array as the parameter (at least as large as SecurityDefinition.SYMBOL_MAX_BYTE_COUNT)

Specified by:

getSymbol in interface SecurityDefinition

Parameters:

symbol - byte array to populate with the UTF-8 bytes of the symbol

getMinPriceIncrementAsMantissa

public long getMinPriceIncrementAsMantissa()

Description copied from interface: SecurityDefinition

The granularity of prices for this security (on this venue). If the pip is at the 4th decimal place and the granularity is a tenth-pip, this value will be 10000 (0.00001 * 10^9)

Specified by:

getMinPriceIncrementAsMantissa in interface SecurityDefinition

Returns:

the granularity of the price or MIN_PRICE_INCREMENT_NULL_VALUE if missing

getBigPriceIncrementAsMantissa

public long getBigPriceIncrementAsMantissa()

Description copied from interface: SecurityDefinition

The location of the big figure for this price. If it's at the 3rd decimal place this value will be 1000000 (0.001 * 10^9) for example.

Specified by:

getBigPriceIncrementAsMantissa in interface SecurityDefinition

Returns:

big figure position or BIG_PRICE_INCREMENT_NULL_VALUE if missing

getSymbol

public java.lang.String getSymbol()

Description copied from interface: SecurityDefinition

The security symbol (i.e. EURUSD). Creates a String object

Specified by:

getSymbol in interface SecurityDefinition

Returns:

symbol of the security

getMinPriceIncrement

public double getMinPriceIncrement()

Description copied from interface: SecurityDefinition

The granularity of prices for this security (on this venue). If the pip is at the 4th decimal place and the granularity is a tenth-pip, this value will be 0.00001

Specified by:

getMinPriceIncrement in interface SecurityDefinition

Returns:

the granularity of the price, or MIN_PRICE_INCREMENT_NULL_VALUE if missing

getBigPriceIncrement

public double getBigPriceIncrement()

Description copied from interface: SecurityDefinition

The location of the big figure for this price as a decimal - 0.001 for example.

Specified by:

getBigPriceIncrement in interface SecurityDefinition

Returns:

big figure position or BIG_PRICE_INCREMENT_NULL_VALUE if missing