Enum KnockType
- java.lang.Object
-
- java.lang.Enum<KnockType>
-
- com.opengamma.strata.product.option.KnockType
-
- All Implemented Interfaces:
Named
,NamedEnum
,Serializable
,Comparable<KnockType>
public enum KnockType extends Enum<KnockType> implements NamedEnum
The knock type of barrier event.This defines the knock type of
Barrier
.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isKnockIn()
Checks if the type is 'Knock-in'.static KnockType
of(String name)
Obtains an instance from the specified name.String
toString()
Returns the formatted name of the type.static KnockType
valueOf(String name)
Returns the enum constant of this type with the specified name.static KnockType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Method Detail
-
values
public static KnockType[] 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 (KnockType c : KnockType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static KnockType 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 KnockType 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
-
isKnockIn
public boolean isKnockIn()
Checks if the type is 'Knock-in'.- Returns:
- true if knock-in, false if knock-out
-
-