org.jquantlib.time

Enum Weekday

java.lang.Object

java.lang.Enum<Weekday>

org.jquantlib.time.Weekday

All Implemented Interfaces:

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

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

Day's serial number MOD 7

WEEKDAY Excel function is the same except for Sunday = 7.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLongFormat() Returns the name of weekdays in long format
java.lang.String	getShortestFormat() Returns the name of weekdays in shortest format.
java.lang.String	getShortFormat() Returns the name of weekdays in short format (3 letters)
java.lang.String	toString() Returns the name of weekdays in long format
int	value() Returns the week day as a number where Sunday (1) till Saturday (7)
static Weekday	valueOf(int value) Returns a new Weekday object given its cardinality
static Weekday	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Weekday[]	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

Sunday

public static final Weekday Sunday

Monday

public static final Weekday Monday

Tuesday

public static final Weekday Tuesday

Wednesday

public static final Weekday Wednesday

Thursday

public static final Weekday Thursday

Friday

public static final Weekday Friday

Saturday

public static final Weekday Saturday

Method Detail

values

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

Returns:

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

valueOf

public static Weekday 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 Weekday valueOf(int value)

Returns a new Weekday object given its cardinality

Parameters:

value - is the cardinality from 1 (Sunday) till 7 (Saturday)

Returns:

a new Weekday object given its cardinality

value

public int value()

Returns the week day as a number where Sunday (1) till Saturday (7)

Returns:

the week day as a number where Sunday (1) till Saturday (7)

toString

public java.lang.String toString()

Returns the name of weekdays in long format

Overrides:

toString in class java.lang.Enum<Weekday>

Returns:

the name of weekdays in long format

See Also:

getLongFormat()

getLongFormat

public java.lang.String getLongFormat()

Returns the name of weekdays in long format

Returns:

the name of weekdays in long format

See Also:

toString()

getShortFormat

public java.lang.String getShortFormat()

Returns the name of weekdays in short format (3 letters)

Returns:

the name of weekdays in short format (3 letters)

getShortestFormat

public java.lang.String getShortestFormat()

Returns the name of weekdays in shortest format. (2 letters)

Returns:

the name of weekdays in shortest format (2 letters)