com.opengamma.strata.product.option

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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KNOCK_IN Knock-in
KNOCK_OUT Knock-out

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opengamma.strata.collect.named.NamedEnum

getName

Methods inherited from interface com.opengamma.strata.collect.named.Named

of

Enum Constant Detail

KNOCK_IN

public static final KnockType KNOCK_IN

Knock-in

KNOCK_OUT

public static final KnockType KNOCK_OUT

Knock-out

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 name

NullPointerException - 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

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<KnockType>

Returns:

the formatted string representing the type