Package net.finmath.smartcontract.product.xml

Enum Class AveragingMethodEnum

java.lang.Object

java.lang.Enum<AveragingMethodEnum>

net.finmath.smartcontract.product.xml.AveragingMethodEnum

All Implemented Interfaces:

Serializable, Comparable<AveragingMethodEnum>, Constable

public enum AveragingMethodEnum
extends Enum<AveragingMethodEnum>

Java class for AveragingMethodEnum.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="AveragingMethodEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Unweighted"/>
     <enumeration value="Weighted"/>
   </restriction>
 </simpleType>
 

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
UNWEIGHTED	The arithmetic mean of the relevant rates for each reset date.
WEIGHTED	The arithmetic mean of the relevant rates in effect for each day in a calculation period calculated by multiplying each relevant rate by the number of days such relevant rate is in effect, determining the sum of such products and dividing such sum by the number of days in the calculation period.

Method Summary

Modifier and Type	Method	Description
static AveragingMethodEnum	fromValue(String v)
String	value()
static AveragingMethodEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AveragingMethodEnum[]	values()	Returns an array containing the constants of this enum class, 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

UNWEIGHTED

public static final AveragingMethodEnum UNWEIGHTED

The arithmetic mean of the relevant rates for each reset date.

WEIGHTED

public static final AveragingMethodEnum WEIGHTED

The arithmetic mean of the relevant rates in effect for each day in a calculation period calculated by multiplying each relevant rate by the number of days such relevant rate is in effect, determining the sum of such products and dividing such sum by the number of days in the calculation period.

Method Details

values

public static AveragingMethodEnum[] values()

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

Returns:

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

valueOf

public static AveragingMethodEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static AveragingMethodEnum fromValue(String v)