Skip to content

//core/io.islandtime/DayOfWeek

DayOfWeek

common

enum DayOfWeek : Enum<DayOfWeek>

A day of the week.

Entries

MONDAY

common

MONDAY

TUESDAY

common

TUESDAY

WEDNESDAY

common

WEDNESDAY

THURSDAY

common

THURSDAY

FRIDAY

common

FRIDAY

SATURDAY

common

SATURDAY

SUNDAY

common

SUNDAY

Types

Name Summary
Companion

common


object Companion

Properties

Name Summary
entries

common


val entries: EnumEntries<DayOfWeek>

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

common


val name: String
number

common


val number: Int

The ISO day of week number.
ordinal

common


val ordinal: Int

Functions

Name Summary
displayName

common


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

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

common


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

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

common


operator fun minus(days: Days): DayOfWeek

Returns this day of the week with days subtracted from it, wrapping when the beginning or end of the week is reached.
number

common


fun number(settings: WeekSettings): Int

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

common


fun number(locale: Locale): 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.
plus

common


operator fun plus(days: Days): DayOfWeek

Returns this day of the week with days added to it, wrapping when the beginning or end of the week is reached.
valueOf

common


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

common


fun values(): Array<DayOfWeek>

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