DateTimeField¶

common

enum DateTimeField : Enum<DateTimeField>

A field describing a property of a date, time, or measurement of time.

These are intended to be used primarily during parsing and formatting. Each date-time primitive is capable of resolving or supplying the set of fields that are applicable to it.

Entries¶


YEAR	common `YEAR` The proleptic year.
YEAR_OF_ERA	common `YEAR_OF_ERA` The year of the era.
ERA	common `ERA` The era.
MONTH_OF_YEAR	common `MONTH_OF_YEAR` The month of the year, such as `January`
DAY_OF_YEAR	common `DAY_OF_YEAR` The day of the year.
DAY_OF_MONTH	common `DAY_OF_MONTH` The day of the month.
DAY_OF_WEEK	common `DAY_OF_WEEK` The day of the week, such as `Sunday`.
AM_PM_OF_DAY	common `AM_PM_OF_DAY` AM or PM of the day.
HOUR_OF_DAY	common `HOUR_OF_DAY` The hour of the day, from 0 to 23.
MINUTE_OF_HOUR	common `MINUTE_OF_HOUR` The minute of the hour, from 0 to 59.
SECOND_OF_MINUTE	common `SECOND_OF_MINUTE` The second of the minute, from 0 to 59.
NANOSECOND_OF_SECOND	common `NANOSECOND_OF_SECOND` The nanosecond of the second, from 0 to 999,999,999.
MILLISECOND_OF_SECOND	common `MILLISECOND_OF_SECOND` The millisecond of the second, from 0 to 999.
UTC_OFFSET_SIGN	common `UTC_OFFSET_SIGN` The sign of the UTC offset, -1 (negative) or 1 (positive).
UTC_OFFSET_HOURS	common `UTC_OFFSET_HOURS` The hour component of the UTC offset, from 0-18.
UTC_OFFSET_MINUTES	common `UTC_OFFSET_MINUTES` The minute component of the UTC offset, from 0-59.
UTC_OFFSET_SECONDS	common `UTC_OFFSET_SECONDS` The second component of the UTC offset, from 0-59.
UTC_OFFSET_TOTAL_SECONDS	common `UTC_OFFSET_TOTAL_SECONDS` The total number of seconds in the UTC offset, from (-18 * 60 * 60) to (18 * 60 * 60).
PERIOD_SIGN	common `PERIOD_SIGN` The sign of the period, -1 (negative) or 1 (positive).
PERIOD_OF_YEARS	common `PERIOD_OF_YEARS` A period of years.
PERIOD_OF_MONTHS	common `PERIOD_OF_MONTHS` A period of months.
PERIOD_OF_WEEKS	common `PERIOD_OF_WEEKS` A period of weeks.
PERIOD_OF_DAYS	common `PERIOD_OF_DAYS` A period of days.
DURATION_OF_HOURS	common `DURATION_OF_HOURS` A duration of hours.
DURATION_OF_MINUTES	common `DURATION_OF_MINUTES` A duration of minutes.
DURATION_OF_SECONDS	common `DURATION_OF_SECONDS` A duration of seconds.
IS_UNBOUNDED	common `IS_UNBOUNDED` Indicates the presence of the minimum or maximum sentinel value, which should treated as unbounded (in ISO-8601 parlance, "open") in the context of an interval.

Properties¶

Name	Summary
entries	common `val entries: EnumEntries<DateTimeField>` Returns a representation of an immutable list of all enum entries, in the order they're declared.
name	common `val name: String`
ordinal	common `val ordinal: Int`

Functions¶

Name	Summary
valueOf	common `fun valueOf(value: String): DateTimeField` 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<DateTimeField>` Returns an array containing the constants of this enum type, in the order they're declared.