net.degreedays.time

Enum DayOfWeek

java.lang.Object

java.lang.Enum<DayOfWeek>

net.degreedays.time.DayOfWeek

All Implemented Interfaces:

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

public enum DayOfWeek
extends java.lang.Enum<DayOfWeek>
implements java.io.Serializable

Defines the day of the week, with enum constants to represent all 7 (Monday to Sunday).

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRIDAY Representing Friday, with toString() of "Friday", and isoIndex() of 5.
MONDAY Representing Monday, with toString() of "Monday", and isoIndex() of 1.
SATURDAY Representing Saturday, with toString() of "Saturday", and isoIndex() of 6.
SUNDAY Representing Sunday, with toString() of "Sunday", and isoIndex() of 7.
THURSDAY Representing Thursday, with toString() of "Thursday", and isoIndex() of 4.
TUESDAY Representing Tuesday, with toString() of "Tuesday", and isoIndex() of 2.
WEDNESDAY Representing Wednesday, with toString() of "Wednesday", and isoIndex() of 3.

Method Summary

Modifier and Type	Method and Description
static DayOfWeek	fromIsoIndex(int isoIndex) Returns the non-null DayOfWeek represented by isoIndex, which can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.
static DayOfWeek	fromString(java.lang.String string) Returns the non-null DayOfWeek with the specified string (returned by its toString() method).
boolean	isFriday() Returns true if this DayOfWeek enum constant is FRIDAY; false otherwise.
boolean	isMonday() Returns true if this DayOfWeek enum constant is MONDAY; false otherwise.
int	isoIndex() Returns the ISO weekday number for this DayOfWeek: 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, and 7 for Sunday.
boolean	isSaturday() Returns true if this DayOfWeek enum constant is SATURDAY; false otherwise.
boolean	isSunday() Returns true if this DayOfWeek enum constant is SUNDAY; false otherwise.
boolean	isThursday() Returns true if this DayOfWeek enum constant is THURSDAY; false otherwise.
boolean	isTuesday() Returns true if this DayOfWeek enum constant is TUESDAY; false otherwise.
boolean	isWednesday() Returns true if this DayOfWeek enum constant is WEDNESDAY; false otherwise.
DayOfWeek	next() Returns the non-null DayOfWeek that comes immediately after this DayOfWeek (e.g. as Monday comes after Sunday).
DayOfWeek	previous() Returns the non-null DayOfWeek that comes immediately before this DayOfWeek (e.g. as Sunday comes before Monday).
java.lang.String	toString() Returns a non-null, non-empty string representation of this enum constant: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", or "Sunday".
static DayOfWeek	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DayOfWeek[]	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

MONDAY

public static final DayOfWeek MONDAY

Representing Monday, with toString() of "Monday", and isoIndex() of 1.

TUESDAY

public static final DayOfWeek TUESDAY

Representing Tuesday, with toString() of "Tuesday", and isoIndex() of 2.

WEDNESDAY

public static final DayOfWeek WEDNESDAY

Representing Wednesday, with toString() of "Wednesday", and isoIndex() of 3.

THURSDAY

public static final DayOfWeek THURSDAY

Representing Thursday, with toString() of "Thursday", and isoIndex() of 4.

FRIDAY

public static final DayOfWeek FRIDAY

Representing Friday, with toString() of "Friday", and isoIndex() of 5.

SATURDAY

public static final DayOfWeek SATURDAY

Representing Saturday, with toString() of "Saturday", and isoIndex() of 6.

SUNDAY

public static final DayOfWeek SUNDAY

Representing Sunday, with toString() of "Sunday", and isoIndex() of 7.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this enum constant: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", or "Sunday".

Overrides:

toString in class java.lang.Enum<DayOfWeek>

See Also:

fromString(java.lang.String)

isoIndex

public int isoIndex()

Returns the ISO weekday number for this DayOfWeek: 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, and 7 for Sunday.

See Also:

fromIsoIndex(int)

isMonday

public boolean isMonday()

Returns true if this DayOfWeek enum constant is MONDAY; false otherwise.

isTuesday

public boolean isTuesday()

Returns true if this DayOfWeek enum constant is TUESDAY; false otherwise.

isWednesday

public boolean isWednesday()

Returns true if this DayOfWeek enum constant is WEDNESDAY; false otherwise.

isThursday

public boolean isThursday()

Returns true if this DayOfWeek enum constant is THURSDAY; false otherwise.

isFriday

public boolean isFriday()

Returns true if this DayOfWeek enum constant is FRIDAY; false otherwise.

isSaturday

public boolean isSaturday()

Returns true if this DayOfWeek enum constant is SATURDAY; false otherwise.

isSunday

public boolean isSunday()

Returns true if this DayOfWeek enum constant is SUNDAY; false otherwise.

next

public DayOfWeek next()

Returns the non-null DayOfWeek that comes immediately after this DayOfWeek (e.g. as Monday comes after Sunday).

previous

public DayOfWeek previous()

Returns the non-null DayOfWeek that comes immediately before this DayOfWeek (e.g. as Sunday comes before Monday).

fromString

public static DayOfWeek fromString(java.lang.String string)
                            throws java.lang.IllegalArgumentException

Returns the non-null DayOfWeek with the specified string (returned by its toString() method).

Throws:

java.lang.NullPointerException - if string is null.

java.lang.IllegalArgumentException - if string is not one of "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", or "Sunday".

See Also:

toString()

fromIsoIndex

public static DayOfWeek fromIsoIndex(int isoIndex)

Returns the non-null DayOfWeek represented by isoIndex, which can be 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

Throws:

java.lang.IndexOutOfBoundsException - if isoIndex is not 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, 6 for Saturday, or 7 for Sunday.

See Also:

isoIndex()