com.marketfactory.mfclient.api

Class MFUtil

java.lang.Object

com.marketfactory.mfclient.api.MFUtil

public final class MFUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_STRING
static long	PRICE_EXPONENT
static long	PRICE_MULTIPLIER
static long	QTY_EXPONENT
static long	QTY_MULTIPLIER

Method Summary

Modifier and Type	Method and Description
static java.lang.Boolean	convert(mftrading.Boolean bool) Converts from an SBE Boolean to a Java Boolean, or null if the value is not representable as a Boolean.
static void	convertAndPad(java.lang.String source, byte[] destination) Copies a source String to the provided byte array - formatted as UTF-8.
static byte[]	convertAndPad(java.lang.String source, int size) Copies a source String to a new byte array - formatted as UTF-8.
static double	convertMantissaToPrice(long mantissa) Converts a mantissa formatted price (used in the SBE methods) into a double.
static double	convertMantissaToQuantity(long mantissa) Converts a mantissa formatted quantity (used in the SBE methods) into a double.
static long	convertPriceToMantissa(double price) Converts a price to the Mantissa format required by some of the API methods.
static long	convertQuantityToMantissa(double quantity) Converts a quantity to the Mantissa format required by some of the API methods.
static long	convertQuantityToMantissa(long quantity) Converts a quantity to the Mantissa format required by some of the API methods.
static java.util.Date	toDate(int daysPastEpoch, int nullValue) Deprecated. Consider using the LocalDate variant of this converter
static int	toDaysPastEpoch(java.time.LocalDate date) Converts a LocalDate instance to epoch days.
static java.time.LocalDate	toLocalDate(int daysPastEpoch, int nullValue) Convert specified number of days past epoch to a LocalDate object
static java.lang.String	toString(byte[] buffer) Convert an SBE text field to java String.
static java.lang.String	toString(int daysPastEpoch, int nullValue) Convert number of days past epoch to a string for easy printing.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

QTY_EXPONENT

public static final long QTY_EXPONENT

See Also:

Constant Field Values

QTY_MULTIPLIER

public static final long QTY_MULTIPLIER

PRICE_EXPONENT

public static final long PRICE_EXPONENT

See Also:

Constant Field Values

PRICE_MULTIPLIER

public static final long PRICE_MULTIPLIER

Method Detail

toString

public static java.lang.String toString(byte[] buffer)

Convert an SBE text field to java String.

toString

public static java.lang.String toString(int daysPastEpoch,
                                        int nullValue)

Convert number of days past epoch to a string for easy printing. The date format is date at UTC 00:00:00.

If the value is equal to the provided null value an empty string is returned.

Parameters:

daysPastEpoch - the number of days after epoch (Jan 1 1970)

nullValue - the value that represents null

Returns:

date at 00:00:00 UTC or an empty string

toDate

public static java.util.Date toDate(int daysPastEpoch,
                                    int nullValue)

Deprecated. Consider using the LocalDate variant of this converter

Convert the specified number of days past epoch to a Date object at 00:00:00 UTC

Consider using the LocalDate variant of this converter since LocalDate does not have a time component

Parameters:

daysPastEpoch - the number of days after epoch (Jan 1 1970)

nullValue - the value that represents null

Returns:

Date representing the specified days past epoch, or null

toLocalDate

public static java.time.LocalDate toLocalDate(int daysPastEpoch,
                                              int nullValue)

Convert specified number of days past epoch to a LocalDate object

Parameters:

daysPastEpoch - the number of days after epoch (Jan 1 1970)

nullValue - the value that represents null

Returns:

LocalDate representing the number of days past epoch, or null

toDaysPastEpoch

public static int toDaysPastEpoch(java.time.LocalDate date)
                           throws java.lang.IllegalArgumentException

Converts a LocalDate instance to epoch days. The maximum supported LocalDate is July 11, 5881580. This is Integer.MAX_VALUE epoch days. If the date exceeds this value, an IllegalArgumentException will be thrown.

Parameters:

date - to convert to days past epoch

Returns:

the days past epoch this local date represents if it's below the maximum value

Throws:

java.lang.IllegalArgumentException

convertQuantityToMantissa

public static long convertQuantityToMantissa(long quantity)

Converts a quantity to the Mantissa format required by some of the API methods. The value provided is multiplied by QTY_EXPONENT.

Parameters:

quantity - quantity to convert

Returns:

the mantissa formatted quantity

convertQuantityToMantissa

public static long convertQuantityToMantissa(double quantity)

Converts a quantity to the Mantissa format required by some of the API methods. The value provided is multiplied by QTY_MULTIPLIER.

If your quantity has more than QTY_EXPONENT decimal places, that information will be lost. There is no rounding.

Parameters:

quantity - quantity to convert

Returns:

the mantissa formatted quantity

convertPriceToMantissa

public static long convertPriceToMantissa(double price)

Converts a price to the Mantissa format required by some of the API methods. The value provided is multiplied by PRICE_MULTIPLIER.

If your value has more than PRICE_EXPONENT decimal places, then normal rounding will occur.

Parameters:

price - price to convert

Returns:

the mantissa formatted price

convertMantissaToPrice

public static double convertMantissaToPrice(long mantissa)

Converts a mantissa formatted price (used in the SBE methods) into a double. A mantissa formatted price has no decimal places and is divided by PRICE_MULTIPLIER to produce the result.

Parameters:

mantissa - price in mantissa format

Returns:

a double formatted price

convertMantissaToQuantity

public static double convertMantissaToQuantity(long mantissa)

Converts a mantissa formatted quantity (used in the SBE methods) into a double. A mantissa formatted quantity has no decimal places and is divided by QTY_MULTIPLIER to produce the result.

Parameters:

mantissa - quantity to convert in mantissa format

Returns:

a double formatted quantity

convert

public static java.lang.Boolean convert(mftrading.Boolean bool)

Converts from an SBE Boolean to a Java Boolean, or null if the value is not representable as a Boolean.

Parameters:

bool - SBE value to convert

Returns:

a Java Boolean object, or null if value cannot be converted

convertAndPad

public static void convertAndPad(java.lang.String source,
                                 byte[] destination)

Copies a source String to the provided byte array - formatted as UTF-8. The destination array must be large enough to hold the bytes from the source or an IndexOutOfBoundsException will be thrown.

Parameters:

source - string to convert

destination - byte array to copy the source string's bytes into

convertAndPad

public static byte[] convertAndPad(java.lang.String source,
                                   int size)

Copies a source String to a new byte array - formatted as UTF-8. The size of the output byte array is as specified by the size parameter. The size must be large enough to hold all the bytes from the source String (UTF-8 formatted) or an IndexOutOfBoundsException will be thrown.

Parameters:

source - string to convert

size - size of the output byte array

Returns:

byte array of specified size, holding the UTF-8 bytes of the source String