com.dxfeed.glossary

Class AdditionalUnderlyings

java.lang.Object

com.dxfeed.glossary.AdditionalUnderlyings

All Implemented Interfaces:

Serializable

public class AdditionalUnderlyings
extends Object
implements Serializable

Represents a set of additional underlyings for a given option. Each additional underlying has assiciated parameter called SPC (shares per contract) that specifies how many shares of additional underlying are delivered during settlement of the option. In cases when option delivers additional cash the SPC specifies an amount of how much cash is delivered.

See getText() and getMap() for details about used formats and representations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AdditionalUnderlyings	EMPTY Empty additional underlyings - it has empty text and empty map.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,Double>	getMap() Returns internal representation of additional underlyings as a map from underlying symbol to its SPC.
double	getSPC(String symbol) Returns SPC for specified underlying symbol or 0 is specified symbol is not found.
static double	getSPC(String text, String symbol) Returns SPC for specified underlying symbol or 0 is specified symbol is not found.
String	getText() Returns textual representation of additional underlyings in the format:
int	hashCode()
String	toString()
static AdditionalUnderlyings	valueOf(Map<String,Double> map) Returns an instance of additional underlyings for specified internal representation.
static AdditionalUnderlyings	valueOf(String text) Returns an instance of additional underlyings for specified textual representation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final AdditionalUnderlyings EMPTY

Empty additional underlyings - it has empty text and empty map.

Method Detail

valueOf

public static AdditionalUnderlyings valueOf(String text)

Returns an instance of additional underlyings for specified textual representation. See getText() for format specification.

Throws:

IllegalArgumentException - if text uses wrong format or contains invalid values

valueOf

public static AdditionalUnderlyings valueOf(Map<String,Double> map)

Returns an instance of additional underlyings for specified internal representation. See getMap() for details about internal representation.

Throws:

IllegalArgumentException - if data contains invalid values

getSPC

public static double getSPC(String text,
                            String symbol)

Returns SPC for specified underlying symbol or 0 is specified symbol is not found. This method is equivalent to expression "valueOf(text).getSPC(symbol)" except it does not check correctness of format.

getText

public String getText()

Returns textual representation of additional underlyings in the format:

 TEXT ::= "" | LIST
 LIST ::= AU | AU "; " LIST
 AU ::= UNDERLYING " " SPC
 

Where UNDERLYING is a symbol of underlying instrument and SPC is a number of shares per contract of that underlying. All additional underlyings are listed in the alphabetical order of underlying symbol. In cases when option settles with additional cash the underlying symbol will specify cash symbol and SPC will specify amount of cash.

getMap

public Map<String,Double> getMap()

Returns internal representation of additional underlyings as a map from underlying symbol to its SPC.

getSPC

public double getSPC(String symbol)

Returns SPC for specified underlying symbol or 0 is specified symbol is not found.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object