org.jfin.date

Enum Frequency

java.lang.Object

java.lang.Enum<Frequency>

org.jfin.date.Frequency

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Frequency>

public enum Frequency
extends java.lang.Enum<Frequency>

Utility class providing a type safe way of describing common periods.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNUALLY Repeats on the same day every year
DAILY Repeats every day
LUNAR_MONTHLY Repeats every 28 days
MONTHLY Repeats on the same day of every month
QUARTERLY Repeats on the same day every three months
SEMI_ANNUALLY Repeats on the same day every six months
WEEKLY Repeats every day

Method Summary

Modifier and Type	Method and Description
int	getPeriodAmount() Returns the amount to adjust, e.g.
int	getPeriodUnit() Returns the unit upon which the period is based, e.g.
java.lang.String	getTenorDescriptor() Returns the tenor descriptor for this period
static Frequency	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static 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

compareTo, equals, 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 Frequency DAILY

Repeats every day

WEEKLY

public static final Frequency WEEKLY

Repeats every day

LUNAR_MONTHLY

public static final Frequency LUNAR_MONTHLY

Repeats every 28 days

MONTHLY

public static final Frequency MONTHLY

Repeats on the same day of every month

QUARTERLY

public static final Frequency QUARTERLY

Repeats on the same day every three months

SEMI_ANNUALLY

public static final Frequency SEMI_ANNUALLY

Repeats on the same day every six months

ANNUALLY

public static final Frequency ANNUALLY

Repeats on the same day every year

Method Detail

values

public static 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 (Frequency c : 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 Frequency valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getPeriodAmount

public int getPeriodAmount()

Returns the amount to adjust, e.g. Quarterly would return 3

Returns:

The amount to adjust, e.g. Quarterly would return 3

getPeriodUnit

public int getPeriodUnit()

Returns the unit upon which the period is based, e.g. Quarterly would return java.util.GregorianCalendar.MONTH

Returns:

The unit upon which the period is based, e.g. Quarterly would return java.util.GregorianCalendar.MONTH

getTenorDescriptor

public java.lang.String getTenorDescriptor()

Returns the tenor descriptor for this period

Returns:

Returns the tenorDescriptor.