Enum BarrierOptions.BinaryBarrierEventType

java.lang.Object

java.lang.Enum<BarrierOptions.BinaryBarrierEventType>

net.finmath.functions.BarrierOptions.BinaryBarrierEventType

All Implemented Interfaces:

Serializable, Comparable<BarrierOptions.BinaryBarrierEventType>, java.lang.constant.Constable

Enclosing class:

BarrierOptions

public static enum BarrierOptions.BinaryBarrierEventType
extends Enum<BarrierOptions.BinaryBarrierEventType>

Barrier-event style for strike-free binary barriers.

Version:

1.0

Author:

Alessandro Gnoatto

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIT	Pays if the barrier has been hit before maturity.
NO_HIT	Pays if the barrier has not been hit before maturity.

Method Summary

Modifier and Type	Method	Description
static BarrierOptions.BinaryBarrierEventType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BarrierOptions.BinaryBarrierEventType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HIT

public static final BarrierOptions.BinaryBarrierEventType HIT

Pays if the barrier has been hit before maturity.

NO_HIT

public static final BarrierOptions.BinaryBarrierEventType NO_HIT

Pays if the barrier has not been hit before maturity.

Method Details

values

public static BarrierOptions.BinaryBarrierEventType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BarrierOptions.BinaryBarrierEventType 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