com.dxfeed.ipf

Enum InstrumentProfileField

java.lang.Object

java.lang.Enum<InstrumentProfileField>

com.dxfeed.ipf.InstrumentProfileField

All Implemented Interfaces:

Serializable, Comparable<InstrumentProfileField>

public enum InstrumentProfileField
extends Enum<InstrumentProfileField>

Defines standard fields of InstrumentProfile and provides data access methods. Please see Instrument Profile Format documentation for complete description.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDITIONAL_UNDERLYINGS
BASE_CURRENCY
CFI
COUNTRY
CURRENCY
CUSIP
DESCRIPTION
EXCHANGE_DATA
EXCHANGES
EXPIRATION
EXPIRATION_STYLE
ICB
ISIN
LAST_TRADE
LOCAL_DESCRIPTION
LOCAL_SYMBOL
MMY
MULTIPLIER
OPOL
OPTION_TYPE
PRICE_INCREMENTS
PRODUCT
SEDOL
SETTLEMENT_STYLE
SIC
SPC
STRIKE
SYMBOL
TRADING_HOURS
TYPE
UNDERLYING

Method Summary

Modifier and Type	Method and Description
static InstrumentProfileField	find(String name) Returns field for specified name or null if field is not found.
static String	formatDate(int d)
static String	formatNumber(double d)
String	getField(InstrumentProfile ip) Returns value of this field for specified profile in textual representation.
double	getNumericField(InstrumentProfile ip) Returns value of this field for specified profile in numeric representation.
Class<?>	getType() Returns type of this field.
boolean	isNumericField() Returns "true" if this field supports numeric representation of a value.
static int	parseDate(String s)
static double	parseNumber(String s)
void	setField(InstrumentProfile ip, String value) Sets value of this field (in textual representation) to specified profile.
void	setNumericField(InstrumentProfile ip, double value) Sets value of this field (in numeric representation) to specified profile.
static InstrumentProfileField	valueOf(String name) Returns the enum constant of this type with the specified name.
static InstrumentProfileField[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPE

public static final InstrumentProfileField TYPE

SYMBOL

public static final InstrumentProfileField SYMBOL

DESCRIPTION

public static final InstrumentProfileField DESCRIPTION

LOCAL_SYMBOL

public static final InstrumentProfileField LOCAL_SYMBOL

LOCAL_DESCRIPTION

public static final InstrumentProfileField LOCAL_DESCRIPTION

COUNTRY

public static final InstrumentProfileField COUNTRY

OPOL

public static final InstrumentProfileField OPOL

EXCHANGE_DATA

public static final InstrumentProfileField EXCHANGE_DATA

EXCHANGES

public static final InstrumentProfileField EXCHANGES

CURRENCY

public static final InstrumentProfileField CURRENCY

BASE_CURRENCY

public static final InstrumentProfileField BASE_CURRENCY

CFI

public static final InstrumentProfileField CFI

ISIN

public static final InstrumentProfileField ISIN

SEDOL

public static final InstrumentProfileField SEDOL

CUSIP

public static final InstrumentProfileField CUSIP

ICB

public static final InstrumentProfileField ICB

SIC

public static final InstrumentProfileField SIC

MULTIPLIER

public static final InstrumentProfileField MULTIPLIER

PRODUCT

public static final InstrumentProfileField PRODUCT

UNDERLYING

public static final InstrumentProfileField UNDERLYING

SPC

public static final InstrumentProfileField SPC

ADDITIONAL_UNDERLYINGS

public static final InstrumentProfileField ADDITIONAL_UNDERLYINGS

MMY

public static final InstrumentProfileField MMY

EXPIRATION

public static final InstrumentProfileField EXPIRATION

LAST_TRADE

public static final InstrumentProfileField LAST_TRADE

STRIKE

public static final InstrumentProfileField STRIKE

OPTION_TYPE

public static final InstrumentProfileField OPTION_TYPE

EXPIRATION_STYLE

public static final InstrumentProfileField EXPIRATION_STYLE

SETTLEMENT_STYLE

public static final InstrumentProfileField SETTLEMENT_STYLE

PRICE_INCREMENTS

public static final InstrumentProfileField PRICE_INCREMENTS

TRADING_HOURS

public static final InstrumentProfileField TRADING_HOURS

Method Detail

values

public static InstrumentProfileField[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InstrumentProfileField c : InstrumentProfileField.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InstrumentProfileField valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

find

public static InstrumentProfileField find(String name)

Returns field for specified name or null if field is not found. The difference from valueOf(java.lang.String) method is that later method throws exception for unknown fields.

getField

public String getField(InstrumentProfile ip)

Returns value of this field for specified profile in textual representation.

setField

public void setField(InstrumentProfile ip,
                     String value)

Sets value of this field (in textual representation) to specified profile.

Throws:

IllegalArgumentException - if text uses wrong format or contains invalid values

getType

public Class<?> getType()

Returns type of this field.

isNumericField

public boolean isNumericField()

Returns "true" if this field supports numeric representation of a value.

getNumericField

public double getNumericField(InstrumentProfile ip)

Returns value of this field for specified profile in numeric representation.

Throws:

IllegalArgumentException - if this field has no numeric representation

setNumericField

public void setNumericField(InstrumentProfile ip,
                            double value)

Sets value of this field (in numeric representation) to specified profile.

Throws:

IllegalArgumentException - if this field has no numeric representation

formatNumber

public static String formatNumber(double d)

parseNumber

public static double parseNumber(String s)

formatDate

public static String formatDate(int d)

parseDate

public static int parseDate(String s)