net.objectlab.kit.datecalc.common
Enum IMMPeriod

java.lang.Object
  java.lang.Enum<IMMPeriod>
      net.objectlab.kit.datecalc.common.IMMPeriod

All Implemented Interfaces:

Serializable, Comparable<IMMPeriod>

public enum IMMPeriod
extends Enum<IMMPeriod>

Some instruments require a period different from the usual Quarterly but still following IMM, e.g. Bi Annually which then can be Mar-Sep or Jun-Dec, or Annually.

Version:

$Revision: 200 $ $Date: 2006-10-10 16:15:58 -0400 (Tue, 10 Oct 2006) $

Author:

Benoit Xhenseval, $LastChangedBy: benoitx $

Enum Constant Summary

ANNUALLY
Annually, jump from 1 year to the next

BI_ANNUALY_JUN_DEC
Bi-annually June and December

BI_ANNUALY_MAR_SEP
Bi-annually March and September

QUARTERLY
Conventional period: Quarterly: eg March, June, September, December

Method Summary

static IMMPeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static IMMPeriod[]	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

BI_ANNUALY_MAR_SEP

public static final IMMPeriod BI_ANNUALY_MAR_SEP

Bi-annually March and September

BI_ANNUALY_JUN_DEC

public static final IMMPeriod BI_ANNUALY_JUN_DEC

Bi-annually June and December

QUARTERLY

public static final IMMPeriod QUARTERLY

Conventional period: Quarterly: eg March, June, September, December

ANNUALLY

public static final IMMPeriod ANNUALLY

Annually, jump from 1 year to the next

Method Detail

values

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

Returns:

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

valueOf

public static IMMPeriod 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