kotlinx-datetime/kotlinx.datetime/DayOfWeek

DayOfWeek

enum DayOfWeek : Enum<DayOfWeek> (source)

The enumeration class representing the days of the week.

Usually acquired from LocalDate.dayOfWeek, but can be constructed using the DayOfWeek factory function that accepts the ISO 8601 day number. This number can be obtained from the isoDayNumber property.

Samples

import kotlinx.datetime.*
import kotlin.test.*
import kotlin.time.Clock

fun main() { 
   //sampleStart 
   // Providing different behavior based on what day of the week it is today
val today = Clock.System.todayIn(TimeZone.currentSystemDefault())
when (today.dayOfWeek) {
    DayOfWeek.MONDAY -> check(today.dayOfWeek.isoDayNumber == 1)
    DayOfWeek.TUESDAY -> check(today.dayOfWeek.isoDayNumber == 2)
    DayOfWeek.WEDNESDAY -> check(today.dayOfWeek.isoDayNumber == 3)
    DayOfWeek.THURSDAY -> check(today.dayOfWeek.isoDayNumber == 4)
    DayOfWeek.FRIDAY -> check(today.dayOfWeek.isoDayNumber == 5)
    DayOfWeek.SATURDAY -> check(today.dayOfWeek.isoDayNumber == 6)
    DayOfWeek.SUNDAY -> check(today.dayOfWeek.isoDayNumber == 7)
    else -> TODO("A new day was added to the week?")
} 
   //sampleEnd
}

Entries

Properties

entries

val entries: EnumEntries<DayOfWeek>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

isoDayNumber

val DayOfWeek.isoDayNumber: Int

The ISO 8601 number of the given day of the week. Monday is 1, Sunday is 7.

Functions

toJavaDayOfWeek

fun DayOfWeek.toJavaDayOfWeek(): DayOfWeek

Converts this kotlinx.datetime.DayOfWeek value to a java.time.DayOfWeek value.

valueOf

fun valueOf(value: String): DayOfWeek

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.)

values

fun values(): Array<DayOfWeek>

Returns an array containing the constants of this enum type, in the order they're declared.