DayOfWeek

A day of the week.

enum DayOfWeek : Enum<DayOfWeek>

Entries

MONDAY

common

MONDAY()

TUESDAY

common

TUESDAY()

WEDNESDAY

common

WEDNESDAY()

THURSDAY

common

THURSDAY()

FRIDAY

common

FRIDAY()

SATURDAY

common

SATURDAY()

SUNDAY

common

SUNDAY()

Types

Companion

common

object Companion

Functions

compareTo

common

operator override fun compareTo(other: DayOfWeek): Int

displayName

common

A textual representation of the day, suitable for display purposes. The localized name will be returned, if available. If not, the ISO day of week number will be returned instead.

The result depends on the configured DateTimeTextProvider and may differ between platforms.

fun displayName(style: TextStyle, locale: Locale): String

equals

common

operator override fun equals(other: Any?): Boolean

hashCode

common

override fun hashCode(): Int

localizedName

common

The localized name of the day, if available for the locale in the specified style. The result depends on the configured DateTimeTextProvider and may differ between platforms.

fun localizedName(style: TextStyle, locale: Locale): String?

minus

common

Subtracts days from this day of the week, wrapping when the beginning or end of the week is reached.

operator fun minus(days: IntDays): DayOfWeek

operator fun minus(days: LongDays): DayOfWeek

number

common

The day of week number (1-7) according to the provided settings. Typically, the week will start on either Monday, Sunday, or Saturday.

fun number(settings: WeekSettings): Int

The day of week number (1-7) according to the specified locale. Typically, the week will start on either Monday, Sunday, or Saturday. The number returned may differ between platforms.

fun number(locale: Locale): Int

plus

common

Adds days to this day of the week, wrapping when the beginning or end of the week is reached.

operator fun plus(days: IntDays): DayOfWeek

operator fun plus(days: LongDays): DayOfWeek

toString

common

open override fun toString(): String

Properties

name

common

override val name: String

number

common

The ISO day of week number.

The ISO week starts on Monday (1) and ends on Sunday (7).

val number: Int

ordinal

common

override val ordinal: Int