org.jquantlib.time

Enum Month

java.lang.Object

java.lang.Enum<Month>

org.jquantlib.time.Month

All Implemented Interfaces:

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

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

Month names

Enum Constant Summary

Enum Constants

Enum Constant and Description
April
August
December
February
January
July
June
March
May
November
October
September

Method Summary

Modifier and Type	Method and Description
char	getImmChar() Returns the IMM char for this Month
java.lang.String	toString()
int	value() Returns the ordinal number of this Month
static Month	valueOf(char immCode) Returns a new month given it's IMM code
static Month	valueOf(int month) Returns a new Month given it's ordinal number
static Month	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Month[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

January

public static final Month January

February

public static final Month February

March

public static final Month March

April

public static final Month April

May

public static final Month May

June

public static final Month June

July

public static final Month July

August

public static final Month August

September

public static final Month September

October

public static final Month October

November

public static final Month November

December

public static final Month December

Method Detail

values

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

Returns:

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

valueOf

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

value

public int value()

Returns the ordinal number of this Month

Returns:

the ordinal number of this Month

valueOf

public static Month valueOf(int month)

Returns a new Month given it's ordinal number

Parameters:

month - is the ordinal number

Returns:

a new Month given it's ordinal number

getImmChar

public char getImmChar()

Returns the IMM char for this Month

Returns:

the IMM char for this Month

See Also:

IMM

valueOf

public static Month valueOf(char immCode)

Returns a new month given it's IMM code

Parameters:

immCode - is the IMM code

Returns:

a new month given it's IMM code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Month>