Package com.opengamma.strata.product.cms
Enum CmsPeriodType
- java.lang.Object
-
- java.lang.Enum<CmsPeriodType>
-
- com.opengamma.strata.product.cms.CmsPeriodType
-
- All Implemented Interfaces:
Named
,NamedEnum
,Serializable
,Comparable<CmsPeriodType>
public enum CmsPeriodType extends Enum<CmsPeriodType> implements NamedEnum
A CMS payment period type.A CMS payment period is a CMS coupon, CMS caplet or CMS floorlet. All of these payments are defined in a unified manner by
CmsPeriod
.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CmsPeriodType
of(String name)
Obtains an instance from the specified name.String
toString()
Returns the formatted name of the type.static CmsPeriodType
valueOf(String name)
Returns the enum constant of this type with the specified name.static CmsPeriodType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
COUPON
public static final CmsPeriodType COUPON
CMS coupon.
-
CAPLET
public static final CmsPeriodType CAPLET
CMS caplet.
-
FLOORLET
public static final CmsPeriodType FLOORLET
CMS floorlet.
-
-
Method Detail
-
values
public static CmsPeriodType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CmsPeriodType c : CmsPeriodType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CmsPeriodType valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
of
public static CmsPeriodType of(String name)
Obtains an instance from the specified name.Parsing handles the mixed case form produced by
toString()
and the upper and lower case variants of the enum constant name.- Parameters:
name
- the name to parse- Returns:
- the type
- Throws:
IllegalArgumentException
- if the name is not known
-
toString
public String toString()
Returns the formatted name of the type.- Overrides:
toString
in classEnum<CmsPeriodType>
- Returns:
- the formatted string representing the type
-
-