com.dxfeed.ipf
Enum InstrumentProfileType

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

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

Defines standard types of InstrumentProfile. Note that other (unknown) types can be used without listing in this class - use it for convenience only. Please see Instrument Profile Format documentation for complete description.


Enum Constant Summary
BOND
           
CURRENCY
           
ETF
           
FOREX
           
FUTURE
           
INDEX
           
MONEY_MARKET_FUND
           
MUTUAL_FUND
           
OPTION
           
OTHER
           
PRODUCT
           
STOCK
           
 
Method Summary
static int compareTypes(java.lang.String type1, java.lang.String type2)
          Compares two specified types for order.
static InstrumentProfileType find(java.lang.String name)
          Returns field for specified name or null if field is not found.
static InstrumentProfileType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static InstrumentProfileType[] 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

CURRENCY

public static final InstrumentProfileType CURRENCY

FOREX

public static final InstrumentProfileType FOREX

BOND

public static final InstrumentProfileType BOND

INDEX

public static final InstrumentProfileType INDEX

STOCK

public static final InstrumentProfileType STOCK

ETF

public static final InstrumentProfileType ETF

MUTUAL_FUND

public static final InstrumentProfileType MUTUAL_FUND

MONEY_MARKET_FUND

public static final InstrumentProfileType MONEY_MARKET_FUND

PRODUCT

public static final InstrumentProfileType PRODUCT

FUTURE

public static final InstrumentProfileType FUTURE

OPTION

public static final InstrumentProfileType OPTION

OTHER

public static final InstrumentProfileType OTHER
Method Detail

values

public static final InstrumentProfileType[] 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(InstrumentProfileType c : InstrumentProfileType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static InstrumentProfileType 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 InstrumentProfileType 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.


compareTypes

public static int compareTypes(java.lang.String type1,
                               java.lang.String type2)
Compares two specified types for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Unlike natual ordering of InstrumentProfileType enum itself this method supports unknown types and orders them alphabetically after standard ones.

The natural ordering implied by this method is designed for convenient data representation in a file and shall not be used for business purposes.