Enum Class DayOfWeek
- All Implemented Interfaces:
Serializable
,Comparable<DayOfWeek>
,Constable
,Calendrical
DayOfWeek
is an enum representing the 7 days of the week -
Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
The calendrical framework requires date-time fields to have an int
value.
The int
value follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday).
It is recommended that applications use the enum rather than the int
value
to ensure code clarity.
Do not use ordinal()
to obtain the numeric representation of DayOfWeek
.
Use getValue()
instead.
This enum represents a common concept that is found in many calendar systems.
As such, this enum may be used by any calendar system that has the day-of-week
concept with a seven day week where the names are equivalent to those defined.
Note that the implementation of DateTimeFieldRule
for day-of-week may
vary by calendar system.
DayOfWeek is an immutable and thread-safe enum.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe singleton instance for the day-of-week of Friday.The singleton instance for the day-of-week of Monday.The singleton instance for the day-of-week of Saturday.The singleton instance for the day-of-week of Sunday.The singleton instance for the day-of-week of Thursday.The singleton instance for the day-of-week of Tuesday.The singleton instance for the day-of-week of Wednesday. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DayOfWeek
firstDayOfWeekFor
(Locale locale) Returns theDayOfWeek
instance that corresponds to the first day-of-week for a givenlocale
.<T> T
get
(CalendricalRule<T> rule) Gets the value of the specified calendrical rule.getShortText
(Locale locale) Gets the short textual representation of this day-of-week, such as 'Mon' or 'Fri'.Gets the full textual representation of this day-of-week, such as 'Monday' or 'Friday'.int
getValue()
Gets the day-of-weekint
value.boolean
isFriday()
Is this instance representing Friday.boolean
isMonday()
Is this instance representing Monday.boolean
Is this instance representing Saturday.boolean
isSunday()
Is this instance representing Sunday.boolean
Is this instance representing Thursday.boolean
Is this instance representing Tuesday.boolean
Is this instance representing Wednesday.next()
Gets the next day-of-week.static DayOfWeek
of
(int dayOfWeek) Obtains an instance ofDayOfWeek
from anint
value.previous()
Gets the previous day-of-week.roll
(int days) Rolls the day-of-week, adding the specified number of days.static DayOfWeek
Returns the enum constant of this class with the specified name.static DayOfWeek[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
MONDAY
The singleton instance for the day-of-week of Monday. This has the numeric value of1
. -
TUESDAY
The singleton instance for the day-of-week of Tuesday. This has the numeric value of2
. -
WEDNESDAY
The singleton instance for the day-of-week of Wednesday. This has the numeric value of3
. -
THURSDAY
The singleton instance for the day-of-week of Thursday. This has the numeric value of4
. -
FRIDAY
The singleton instance for the day-of-week of Friday. This has the numeric value of5
. -
SATURDAY
The singleton instance for the day-of-week of Saturday. This has the numeric value of6
. -
SUNDAY
The singleton instance for the day-of-week of Sunday. This has the numeric value of7
.
-
-
Constructor Details
-
DayOfWeek
private DayOfWeek()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
of
Obtains an instance ofDayOfWeek
from anint
value.DayOfWeek
is an enum representing the 7 days of the week. This factory allows the enum to be obtained from theint
value. Theint
value follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday).An exception is thrown if the value is invalid. The exception uses the
ISOChronology
day-of-week rule to indicate the failed rule.- Parameters:
dayOfWeek
- the day-of-week to represent, from 1 (Monday) to 7 (Sunday)- Returns:
- the DayOfWeek singleton, never null
- Throws:
IllegalCalendarFieldValueException
- if the day-of-week is invalid
-
firstDayOfWeekFor
Returns theDayOfWeek
instance that corresponds to the first day-of-week for a givenlocale
.If there is no information for a locale,
MONDAY
is returned.- Parameters:
locale
- the locale to use, not null- Returns:
- the DayOfWeek singleton, never null
-
getValue
public int getValue()Gets the day-of-weekint
value.The values are numbered following the ISO-8601 standard, from 1 (Monday) to 7 (Sunday).
- Returns:
- the day-of-week, from 1 (Monday) to 7 (Sunday)
-
get
Gets the value of the specified calendrical rule.This returns the one of the day-of-week values if the type of the rule is
DayOfWeek
. Other rules will returnnull
.- Specified by:
get
in interfaceCalendrical
- Parameters:
rule
- the rule to use, not null- Returns:
- the value for the rule, null if the value cannot be returned
-
getShortText
Gets the short textual representation of this day-of-week, such as 'Mon' or 'Fri'.This method is notionally specific to
ISOChronology
as it uses the day-of-week rule to obtain the text. However, it is expected that the text will be equivalent for all day-of-week rules, thus this aspect of the implementation should be irrelevant to applications.If there is no textual mapping for the locale, then the ISO-8601
value
is returned as perInteger.toString()
.- Parameters:
locale
- the locale to use, not null- Returns:
- the short text value of the day-of-week, never null
-
getText
Gets the full textual representation of this day-of-week, such as 'Monday' or 'Friday'.This method is notionally specific to
ISOChronology
as it uses the day-of-week rule to obtain the text. However, it is expected that the text will be equivalent for all day-of-week rules, thus this aspect of the implementation should be irrelevant to applications.If there is no textual mapping for the locale, then the ISO-8601
value
is returned as perInteger.toString()
.- Parameters:
locale
- the locale to use, not null- Returns:
- the full text value of the day-of-week, never null
-
isMonday
public boolean isMonday()Is this instance representing Monday.- Returns:
- true if this instance represents Monday
-
isTuesday
public boolean isTuesday()Is this instance representing Tuesday.- Returns:
- true if this instance represents Tuesday
-
isWednesday
public boolean isWednesday()Is this instance representing Wednesday.- Returns:
- true if this instance represents Wednesday
-
isThursday
public boolean isThursday()Is this instance representing Thursday.- Returns:
- true if this instance represents Thursday
-
isFriday
public boolean isFriday()Is this instance representing Friday.- Returns:
- true if this instance represents Friday
-
isSaturday
public boolean isSaturday()Is this instance representing Saturday.- Returns:
- true if this instance represents Saturday
-
isSunday
public boolean isSunday()Is this instance representing Sunday.- Returns:
- true if this instance represents Sunday
-
next
Gets the next day-of-week.This calculates based on the time-line, thus it rolls around the end of the week. The next day after Sunday is Monday.
- Returns:
- the next day-of-week, never null
-
previous
Gets the previous day-of-week.This calculates based on the time-line, thus it rolls around the end of the week. The previous day before Monday is Sunday.
- Returns:
- the previous day-of-week, never null
-
roll
Rolls the day-of-week, adding the specified number of days.This calculates based on the time-line, thus it rolls around the end of the week from Sunday to Monday. The days to roll by may be negative.
This instance is immutable and unaffected by this method call.
- Parameters:
days
- the days to roll by, positive or negative- Returns:
- the resulting day-of-week, never null
-