Added in API level 26

DayOfWeek

class DayOfWeek : TemporalAccessor, TemporalAdjuster
kotlin.Any
   ↳ kotlin.Enum<java.time.DayOfWeek>
   ↳ java.time.DayOfWeek

A day-of-week, such as 'Tuesday'.

DayOfWeek is an enum representing the 7 days of the week - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

In addition to the textual enum name, each day-of-week has 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.

This enum provides access to the localized textual form of the day-of-week. Some locales also assign different numeric values to the days, declaring Sunday to have the value 1, however this class provides no support for this. See WeekFields for localized week-numbering.

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 defined exactly equivalent to the ISO calendar system.

Summary

Enum values

The 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.
Public methods
Temporal!
adjustInto(temporal: Temporal!)

Adjusts the specified temporal object to have this day-of-week.
static DayOfWeek!
from(temporal: TemporalAccessor!)

Obtains an instance of DayOfWeek from a temporal object.
Int
get(field: TemporalField!)

Gets the value of the specified field from this day-of-week as an int.
String!
getDisplayName(style: TextStyle!, locale: Locale!)

Gets the textual representation, such as 'Mon' or 'Friday'.
Long

Gets the value of the specified field from this day-of-week as a long.
Int

Gets the day-of-week int value.
Boolean

Checks if the specified field is supported.
DayOfWeek!
minus(days: Long)

Returns the day-of-week that is the specified number of days before this one.
static DayOfWeek!
of(dayOfWeek: Int)

Obtains an instance of DayOfWeek from an int value.
DayOfWeek!
plus(days: Long)

Returns the day-of-week that is the specified number of days after this one.
R
query(query: TemporalQuery<R>!)

Queries this day-of-week using the specified query.
ValueRange!

Gets the range of valid values for the specified field.

Enum values

FRIDAY

Added in API level 26
enum val FRIDAY : DayOfWeek

The singleton instance for the day-of-week of Friday. This has the numeric value of 5.

MONDAY

Added in API level 26
enum val MONDAY : DayOfWeek

The singleton instance for the day-of-week of Monday. This has the numeric value of 1.

SATURDAY

Added in API level 26
enum val SATURDAY : DayOfWeek

The singleton instance for the day-of-week of Saturday. This has the numeric value of 6.

SUNDAY

Added in API level 26
enum val SUNDAY : DayOfWeek

The singleton instance for the day-of-week of Sunday. This has the numeric value of 7.

THURSDAY

Added in API level 26
enum val THURSDAY : DayOfWeek

The singleton instance for the day-of-week of Thursday. This has the numeric value of 4.

TUESDAY

Added in API level 26
enum val TUESDAY : DayOfWeek

The singleton instance for the day-of-week of Tuesday. This has the numeric value of 2.

WEDNESDAY

Added in API level 26
enum val WEDNESDAY : DayOfWeek

The singleton instance for the day-of-week of Wednesday. This has the numeric value of 3.

Public methods

adjustInto

Added in API level 26
fun adjustInto(temporal: Temporal!): Temporal!

Adjusts the specified temporal object to have this day-of-week.

This returns a temporal object of the same observable type as the input with the day-of-week changed to be the same as this.

The adjustment is equivalent to using Temporal#with(TemporalField, long) passing ChronoField#DAY_OF_WEEK as the field. Note that this adjusts forwards or backwards within a Monday to Sunday week. See java.time.temporal.WeekFields#dayOfWeek() for localized week start days. See TemporalAdjuster for other adjusters with more control, such as next(MONDAY).

In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster): 

// these two lines are equivalent, but the second approach is recommended
    temporal = thisDayOfWeek.adjustInto(temporal);
    temporal = temporal.with(thisDayOfWeek);

For example, given a date that is a Wednesday, the following are output: 

dateOnWed.with(MONDAY);     // two days earlier
    dateOnWed.with(TUESDAY);    // one day earlier
    dateOnWed.with(WEDNESDAY);  // same date
    dateOnWed.with(THURSDAY);   // one day later
    dateOnWed.with(FRIDAY);     // two days later
    dateOnWed.with(SATURDAY);   // three days later
    dateOnWed.with(SUNDAY);     // four days later

This instance is immutable and unaffected by this method call.

Parameters
temporal Temporal!: the target object to be adjusted, not null
Return
Temporal! the adjusted object, not null
Exceptions
java.time.DateTimeException if unable to make the adjustment
java.lang.ArithmeticException if numeric overflow occurs

from

Added in API level 26
static fun from(temporal: TemporalAccessor!): DayOfWeek!

Obtains an instance of DayOfWeek from a temporal object.

This obtains a day-of-week based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of DayOfWeek.

The conversion extracts the DAY_OF_WEEK field.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, DayOfWeek::from.

Parameters
temporal TemporalAccessor!: the temporal object to convert, not null
Return
DayOfWeek! the day-of-week, not null
Exceptions
java.time.DateTimeException if unable to convert to a DayOfWeek

get

Added in API level 26
fun get(field: TemporalField!): Int

Gets the value of the specified field from this day-of-week as an int.

This queries this day-of-week for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is DAY_OF_WEEK then the value of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Parameters
field TemporalField!: the field to get, not null
Return
Int the value for the field, within the valid range of values
Exceptions
java.time.DateTimeException if a value for the field cannot be obtained or the value is outside the range of valid values for the field
java.time.temporal.UnsupportedTemporalTypeException if the field is not supported or the range of values exceeds an int
java.lang.ArithmeticException if numeric overflow occurs

getDisplayName

Added in API level 26
fun getDisplayName(
    style: TextStyle!, 
    locale: Locale!
): String!

Gets the textual representation, such as 'Mon' or 'Friday'.

This returns the textual name used to identify the day-of-week, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters
style TextStyle!: the length of the text required, not null
locale Locale!: the locale to use, not null
Return
String! the text value of the day-of-week, not null

getLong

Added in API level 26
fun getLong(field: TemporalField!): Long

Gets the value of the specified field from this day-of-week as a long.

This queries this day-of-week for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is DAY_OF_WEEK then the value of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Parameters
field TemporalField!: the field to get, not null
Return
Long the value for the field
Exceptions
java.time.DateTimeException if a value for the field cannot be obtained
java.time.temporal.UnsupportedTemporalTypeException if the field is not supported
java.lang.ArithmeticException if numeric overflow occurs

getValue

Added in API level 26
fun getValue(): Int

Gets the day-of-week int value.

The values are numbered following the ISO-8601 standard, from 1 (Monday) to 7 (Sunday). See java.time.temporal.WeekFields#dayOfWeek() for localized week-numbering.

Return
Int the day-of-week, from 1 (Monday) to 7 (Sunday)

isSupported

Added in API level 26
fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

This checks if this day-of-week can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

If the field is DAY_OF_WEEK then this method returns true. All other ChronoField instances will return false.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

Parameters
field TemporalField!: the field to check, null returns false
Return
Boolean true if the field is supported on this day-of-week, false if not

minus

Added in API level 26
fun minus(days: Long): DayOfWeek!

Returns the day-of-week that is the specified number of days before this one.

The calculation rolls around the start of the year from Monday to Sunday. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters
days Long: the days to subtract, positive or negative
Return
DayOfWeek! the resulting day-of-week, not null

of

Added in API level 26
static fun of(dayOfWeek: Int): DayOfWeek!

Obtains an instance of DayOfWeek from an int value.

DayOfWeek is an enum representing the 7 days of the week. This factory allows the enum to be obtained from the int value. The int value follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday).

Parameters
dayOfWeek Int: the day-of-week to represent, from 1 (Monday) to 7 (Sunday)
Return
DayOfWeek! the day-of-week singleton, not null
Exceptions
java.time.DateTimeException if the day-of-week is invalid

plus

Added in API level 26
fun plus(days: Long): DayOfWeek!

Returns the day-of-week that is the specified number of days after this one.

The calculation rolls around the end of the week from Sunday to Monday. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters
days Long: the days to add, positive or negative
Return
DayOfWeek! the resulting day-of-week, not null

query

Added in API level 26
fun <R : Any!> query(query: TemporalQuery<R>!): R

Queries this day-of-week using the specified query.

This queries this day-of-week using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

Parameters
<R> the type of the result
query TemporalQuery<R>!: the query to invoke, not null
Return
R the query result, null may be returned (defined by the query)
Exceptions
java.time.DateTimeException if unable to query (defined by the query)
java.lang.ArithmeticException if numeric overflow occurs (defined by the query)

range

Added in API level 26
fun range(field: TemporalField!): ValueRange!

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This day-of-week is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

If the field is DAY_OF_WEEK then the range of the day-of-week, from 1 to 7, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

Parameters
field TemporalField!: the field to query the range for, not null
Return
ValueRange! the range of valid values for the field, not null
Exceptions
java.time.DateTimeException if the range for the field cannot be obtained
java.time.temporal.UnsupportedTemporalTypeException if the field is not supported