net.finmath.time

Enum ScheduleGenerator.Frequency

java.lang.Object

java.lang.Enum<ScheduleGenerator.Frequency>

net.finmath.time.ScheduleGenerator.Frequency

All Implemented Interfaces:

Serializable, Comparable<ScheduleGenerator.Frequency>

Enclosing class:

ScheduleGenerator

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

Possible frequencies supported by ScheduleGenerator.

Author:

Christian Fries

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNUAL Twelve months periods.
DAILY Daily periods.
MONTHLY One months periods.
QUARTERLY Three months periods.
SEMIANNUAL Six months periods.
TENOR A single period, i.e., the period is as long as from start to maturity.
WEEKLY Weekly periods.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DAILY

public static final ScheduleGenerator.Frequency DAILY

Daily periods.

WEEKLY

public static final ScheduleGenerator.Frequency WEEKLY

Weekly periods.

MONTHLY

public static final ScheduleGenerator.Frequency MONTHLY

One months periods.

QUARTERLY

public static final ScheduleGenerator.Frequency QUARTERLY

Three months periods.

SEMIANNUAL

public static final ScheduleGenerator.Frequency SEMIANNUAL

Six months periods.

ANNUAL

public static final ScheduleGenerator.Frequency ANNUAL

Twelve months periods.

TENOR

public static final ScheduleGenerator.Frequency TENOR

A single period, i.e., the period is as long as from start to maturity.

Method Detail

values

public static ScheduleGenerator.Frequency[] 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 (ScheduleGenerator.Frequency c : ScheduleGenerator.Frequency.values())
    System.out.println(c);

Returns:

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

valueOf

public static ScheduleGenerator.Frequency 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