|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.dxfeed.glossary.AdditionalUnderlyings
public class AdditionalUnderlyings
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.
Field Summary | |
---|---|
static AdditionalUnderlyings |
EMPTY
Empty additional underlyings - it has empty text and empty map. |
Method Summary | |
---|---|
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: 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. |
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 |
---|
public static final AdditionalUnderlyings EMPTY
Method Detail |
---|
public static AdditionalUnderlyings valueOf(String text)
getText()
for format specification.
IllegalArgumentException
- if text uses wrong format or contains invalid valuespublic static AdditionalUnderlyings valueOf(Map<String,Double> map)
getMap()
for details about internal representation.
IllegalArgumentException
- if data contains invalid valuespublic static double getSPC(String text, String symbol)
public String getText()
TEXT ::= "" | LIST LIST ::= AU | AU "; " LIST AU ::= UNDERLYING " " SPCWhere 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.
public Map<String,Double> getMap()
public double getSPC(String symbol)
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |