Class SurfaceInfoType<T>
- java.lang.Object
-
- com.opengamma.strata.collect.TypedString<SurfaceInfoType<T>>
-
- com.opengamma.strata.market.surface.SurfaceInfoType<T>
-
- Type Parameters:
T
- the type of the associated value
- All Implemented Interfaces:
Named
,Serializable
,Comparable<SurfaceInfoType<T>>
public final class SurfaceInfoType<T> extends TypedString<SurfaceInfoType<T>>
The type that provides meaning to additional surface information.Additional surface information is stored in
SurfaceMetadata
. It provides the ability to associate arbitrary information with a surface in a key-value map. For example, it might be used to provide information about one of the axes.Applications that wish to use surface information should declare a static constant declaring the
SurfaceInfoType
instance, the type parameter and an UpperCamelCase name. For example:public static final SurfaceInfoType<String> OWNER = SurfaceInfoType.of("Owner");
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static SurfaceInfoType<DayCount>
DAY_COUNT
Key used to access information about theDayCount
.static SurfaceInfoType<MoneynessType>
MONEYNESS_TYPE
Key used to access information about the type of moneyness.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <T> SurfaceInfoType<T>
of(String name)
Obtains an instance from the specified name.
-
-
-
Field Detail
-
DAY_COUNT
public static final SurfaceInfoType<DayCount> DAY_COUNT
Key used to access information about theDayCount
.
-
MONEYNESS_TYPE
public static final SurfaceInfoType<MoneynessType> MONEYNESS_TYPE
Key used to access information about the type of moneyness.
-
-
Method Detail
-
of
public static <T> SurfaceInfoType<T> of(String name)
Obtains an instance from the specified name.The name may contain any character, but must not be empty.
- Type Parameters:
T
- the type associated with the info- Parameters:
name
- the name- Returns:
- a type instance with the specified name
-
-