Module net.finmath.lib

Package net.finmath.time

Enum ScheduleGenerator.ShortPeriodConvention

java.lang.Object

java.lang.Enum<ScheduleGenerator.ShortPeriodConvention>

net.finmath.time.ScheduleGenerator.ShortPeriodConvention

All Implemented Interfaces:

Serializable, Comparable<ScheduleGenerator.ShortPeriodConvention>, java.lang.constant.Constable

Enclosing class:

ScheduleGenerator

public static enum ScheduleGenerator.ShortPeriodConvention
extends Enum<ScheduleGenerator.ShortPeriodConvention>

Possible stub period conventions supported.

Author:

Christian Fries

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
FIRST	The first period will be shorter, if a regular period does not fit.
LAST	The last period will be shorter, if a regular period does not fit.

Method Summary

Modifier and Type	Method	Description
static ScheduleGenerator.ShortPeriodConvention	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScheduleGenerator.ShortPeriodConvention[]	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

FIRST

public static final ScheduleGenerator.ShortPeriodConvention FIRST

The first period will be shorter, if a regular period does not fit.

LAST

public static final ScheduleGenerator.ShortPeriodConvention LAST

The last period will be shorter, if a regular period does not fit.

Method Details

values

public static ScheduleGenerator.ShortPeriodConvention[] 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 ScheduleGenerator.ShortPeriodConvention 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