org.jquantlib.time

Enum Frequency

java.lang.Object

java.lang.Enum<Frequency>

org.jquantlib.time.Frequency

All Implemented Interfaces:

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

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

Frequency of events

Enum Constant Summary

Enum Constants

Enum Constant and Description
Annual once a year
Bimonthly every second month
Biweekly every second week
Daily once a day
EveryFourthMonth every fourth month
EveryFourthWeek every fourth week
Monthly once a month
NoFrequency null frequency
Once only once
OtherFrequency some other unknown frequency
Quarterly every third month
Semiannual twice a year
Weekly once a week

Method Summary

Modifier and Type	Method and Description
int	toInteger()
static Frequency	valueOf(int value)
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

NoFrequency

public static final Frequency NoFrequency

null frequency

Once

public static final Frequency Once

only once

Annual

public static final Frequency Annual

once a year

Semiannual

public static final Frequency Semiannual

twice a year

EveryFourthMonth

public static final Frequency EveryFourthMonth

every fourth month

Quarterly

public static final Frequency Quarterly

every third month

Bimonthly

public static final Frequency Bimonthly

every second month

Monthly

public static final Frequency Monthly

once a month

EveryFourthWeek

public static final Frequency EveryFourthWeek

every fourth week

Biweekly

public static final Frequency Biweekly

every second week

Weekly

public static final Frequency Weekly

once a week

Daily

public static final Frequency Daily

once a day

OtherFrequency

public static final Frequency OtherFrequency

some other unknown frequency

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

valueOf

public static Frequency valueOf(int value)

toInteger

public int toInteger()