Module net.finmath.lib

Package net.finmath.modelling.products

Enum CallOrPut

java.lang.Object

java.lang.Enum<CallOrPut>

net.finmath.modelling.products.CallOrPut

All Implemented Interfaces:

Serializable, Comparable<CallOrPut>, java.lang.constant.Constable

public enum CallOrPut
extends Enum<CallOrPut>

Defines once and for all for the library how we treat calls and puts via EuropeanOption classes.

Author:

Alessandro Gnoatto

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CALL
PUT

Method Summary

Modifier and Type	Method	Description
int	toInteger()	Returns the sign associated to an option.
static CallOrPut	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CallOrPut[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CALL

public static final CallOrPut CALL

PUT

public static final CallOrPut PUT

Method Details

values

public static CallOrPut[] 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 CallOrPut 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

toInteger

public int toInteger()

Returns the sign associated to an option.

Returns:

1 for a call and -1 for a put.