com.dxfeed.ipf
Enum InstrumentProfileField

java.lang.Object
  extended by java.lang.Enum<InstrumentProfileField>
      extended by com.dxfeed.ipf.InstrumentProfileField
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<InstrumentProfileField>

public enum InstrumentProfileField
extends java.lang.Enum<InstrumentProfileField>

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


Enum Constant Summary
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
static InstrumentProfileField find(java.lang.String name)
          Returns field for specified name or null if field is not found.
 java.lang.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.
 boolean isNumericField()
          Returns "true" if this field supports numeric representation of a value.
 void setField(InstrumentProfile ip, java.lang.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(java.lang.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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, 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 final InstrumentProfileField[] values()
Returns an array containing the constants of this enum type, in the order they're 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're declared

valueOf

public static InstrumentProfileField valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

find

public static InstrumentProfileField find(java.lang.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 java.lang.String getField(InstrumentProfile ip)
Returns value of this field for specified profile in textual representation.


setField

public void setField(InstrumentProfile ip,
                     java.lang.String value)
Sets value of this field (in textual representation) to specified profile.

Throws:
java.lang.IllegalArgumentException - if text uses wrong format or contains invalid values

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:
java.lang.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:
java.lang.IllegalArgumentException - if this field has no numeric representation